Appboard/old/widgets/area chart: Difference between revisions

imported>Cmace
(created to remove appboard_builder)
 
imported>Cmace
(copied from internalwiki)
Line 1: Line 1:
== Adding a Area Chart Widget ==
An Area Chart Widget is a graphical Widget that is comprised of one or more overlaid line charts, where the region between the x-axis and each line is highlighted in a different color.  This format allows data from multiple sources, over time, to be displayed simultaneously in the same chart.


Click "Add Widget" in the tool palette on the left.  If "Add Widget" is disabled, refer to the "Adding a Stack" section. 
# Enter a name for the Widget
# Select Area Chart Widget
# Select the Board you'd like the Area Chart Widget to appear on.
# Select "OK".


[[Image:areaChartSample.png|thumb|center|500px|Area Chart Sample]]


== Configuring Area Chart ==


# Select a Data Collection that contains the information you'd like to use for this Area chart.
== How To Create an Area Chart Widget ==
#:* Click the "Data Collection" pulldown, then select from the list of available Data Collections.
For instructions on creating a Widget, see the general instructions in [[Widgets#Adding_Widgets|Adding Widgets]].  The <b>Area</b> Widget type is located under the <b>Charts</b> category on the Widget selection screen.
#:* If you do not see any Data Collections, refer to [[Data_Collections|Add/Edit/Remove a Data Collection]].
 
# Select X-Axis Field from the Data Collection that this chart would use as X-Axis.
 
#:* Click the "X-Axis Field" pulldown, and then select an item from the list. Then, click the "Type" pulldown, and then select an item from the list to indicate what field type this "X-Axis Field" is.
== How To Configure an Area Chart Widget ==
#:* An example would be a "Month" field of "CategoryAxis" type.
Follow the instructions above to create the basic "Area Chart" Widget, and then perform the following steps to configure an Area Chart Widget:
# Set the Series to be plotted. "Y-Axis Field" indicates the vertical location of the bubble. "Form" indicates the form of the filled area. "Color" indicates the color filling the area. "Alpha" indicates the transparency of the plotted area.
 
#:* Click "Add" button to add a new series.
 
#:* Click "Y-Axis Field" pulldown, and then select an item from the list.
=== Select a Data Collection ===
#:* Click "Form" pulldown, and then select an item from the list.
Select a '''Data Collection''' that contains the information you would like to use for this Widget.  
#:* Click "Color" chooser to set the color.
* Click the "Data Collection" pulldown, then select from the list of available Data Collections.
#:* Click "Alpha" chooser to set the transparency.
* If you're using the sample CSV data, select "Sample.Data.ChartData".
#:* Click "Overlaid" pulldown, choose to set the stack type.
* If there are no Data Collections available in the pulldown, then click here for instructions on how to bring in some [[Sample_Chart_Data|Sample Chart Data]], or refer to [[Data_Collections|Add/Edit/Remove a Data Collection]].
# Click "Show Legend" option to turn on the display of X-Axis and Y-Axis Legend.
 
# Click "Labels" option to show the X-Axis and/or Y-Axis field's label. Slide the "Rotation" slider to set the label rotation degree. Click "Title" option to show the Title and enter the title to be displayed in the field.
 
#* Complete "Options" and "Actions" steps as described in [[Widgets|Add/Edit/Remove a Widget]].
=== Configuring the X-Axis ===
 
Select the desired '''X-Field''' to use for the X-Axis of the Chart.
* The "rows" of this column of data will make up the X-Axis.
 
If you're using ''Sample.Data.ChartData'', then select "Month" to be the X-Field.
 
 
=== Type ===
Select an option for <b>Type</b> from the drop-down box.  This will be used to determine how the data is translated by AppBoard into the labels that are shown along the x-axis:
* '''LinearAxis''': x-axis values are determined as a linear progression between the lowest and highest values.
* '''LogAxis''': x-axis values are determined as a logarithmic progression between the lowest and highest values. Labels on the logarithmic axis are even powers of 10.
* '''CategoryAxis''': This is the default.  The "rows" observed in the selected column of data will make up the X-Axis.
* '''DateTimeAxis''': x-axis values are determined as time-based values such as hours, days, weeks, or years.
 
 
=== Configuring a Series (Y-Axis) ===
* Click the "Add" button in the button toolbar of the Series DataGrid.
* Repeat to add additional series.
* Series may be removed with the "Remove" button next to the "Add" button.
 
 
==== Y-field====
* Values contained within the "Y-field" will determine the height for that series.
If you're using ''Sample.Data.ChartData'', then select "Software" and "Hardware" as the Y-fields.
 
 
==== Form ====
Specifies the way in which the data series is shown in the chart. The following values are valid:
* '''segment''' Draws lines as connected segments that are angled to connect at each data point in the series. This is the default.
* '''step''' Draws lines as horizontal and vertical segments. At the first data point the chart draws a horizontal line, and then a vertical line to the second point. The chart repeats this action for each data point.
* '''reverseStep''' Draws lines as horizontal and vertical segments. At the first data point the chart draws a vertical line, and then a horizontal line to the second point. The chart repeats this action for each data point.
* '''vertical''' Draws only the vertical line from the y-coordinate of the first point to the y-coordinate of the second point at the x-coordinate of the second point. Repeats this action for each data point.
* '''horizontal''' Draws only the horizontal line from the x-coordinate of the first point to the x-coordinate of the second point at the y-coordinate of the first point. Repeats this action for each data point.
* '''curve''' Draws curves between data points.
 
[[Image:areaChart_Form.png|Sample Area Chart Forms]]
 
 
==== Fill Style ====
* Fill style is purely aesthetic, and sets the rendering style that will be used for the series.
* The available rendering styles are Solid and Gradient.
[[Image:areaChart.png|Sample Area Chart]]
 
 
==== Color ==== 
* Color will work in conjunction with Fill Style to distinguish one series from another.
* You can select color by clicking on the color swatches in the color picker, or you can manually enter a hexadecimal color value.
 
 
==== Alpha ====
* Alpha sets the opacity of the series.
* Reducing the Alpha lets you see grid lines show through the columns.
[[Image:areaChart_Alpha.png|Sample Area Alpha]]
 
 
==== Series Type ====
To select a different Series Type, click the pulldown in the bottom toolbar of the Series Data Grid.
* '''overlaid''': Chart elements for each series are rendered directly on top of each other, with the element corresponding to the last series on top. This is the default value for AreaChart controls.
* '''stacked''': Chart elements for each series are stacked cumulatively above each other. Each element represents the cumulative value of the elements beneath it.
* '''100%''': Chart elements are stacked cumulatively above each other, adding up to 100%. Each chart element represents the percentage that the value contributes to the sum of the values for that category.
[[Image:areaChart_seriesTypes.png|Sample Area Series Types]]
 
 
=== Additional Area Chart Options ===
* Check or uncheck "Show Legend" as desired to include a legend of the line color for each Series (by Y-Field name).
* Enable the X-Axis title and enter value as desired.
* Enable the X-Axis labels and rotate them as desired.
* Enable the Y-Axis title and enter value as desired.
* Enable the Y-Axis labels and rotate them as desired.
 
 
=== Additional Configuration Steps ===
* Enter the following information on the <b>Options</b> tab:
** [Optional] Configure the [[Option_Show_Search_Text|Show Search Text]] Option.
** [Optional] Configure the [[Option_Use_Filter|Use Filter]] Option.
** [Optional] Configure the [[Option_Configure_Alternative_Widget|Configure Alternative Widget]] Option.
** [Optional] Configure the [[Option_Help|Help]] Option.
 
 
* Enter the following information on the <b>Actions</b> tab:
** Click <b>Add Event Action</b> to configure one or more [[Actions|Actions]] to be invoked when a user clicks on the Area Chart Widget.  The action will apply to the current data record being displayed.
 
 
== Sample Data ==
 
Instructions for bringing sample chart data into AppBoard can be found here: [[Sample_Chart_Data|Sample Chart Data]]

Revision as of 16:07, 1 May 2012

An Area Chart Widget is a graphical Widget that is comprised of one or more overlaid line charts, where the region between the x-axis and each line is highlighted in a different color. This format allows data from multiple sources, over time, to be displayed simultaneously in the same chart.


Area Chart Sample


How To Create an Area Chart Widget

For instructions on creating a Widget, see the general instructions in Adding Widgets. The Area Widget type is located under the Charts category on the Widget selection screen.


How To Configure an Area Chart Widget

Follow the instructions above to create the basic "Area Chart" Widget, and then perform the following steps to configure an Area Chart Widget:


Select a Data Collection

Select a Data Collection that contains the information you would like to use for this Widget.

  • Click the "Data Collection" pulldown, then select from the list of available Data Collections.
  • If you're using the sample CSV data, select "Sample.Data.ChartData".
  • If there are no Data Collections available in the pulldown, then click here for instructions on how to bring in some Sample Chart Data, or refer to Add/Edit/Remove a Data Collection.


Configuring the X-Axis

Select the desired X-Field to use for the X-Axis of the Chart.

  • The "rows" of this column of data will make up the X-Axis.
If you're using Sample.Data.ChartData, then select "Month" to be the X-Field.


Type

Select an option for Type from the drop-down box. This will be used to determine how the data is translated by AppBoard into the labels that are shown along the x-axis:

  • LinearAxis: x-axis values are determined as a linear progression between the lowest and highest values.
  • LogAxis: x-axis values are determined as a logarithmic progression between the lowest and highest values. Labels on the logarithmic axis are even powers of 10.
  • CategoryAxis: This is the default. The "rows" observed in the selected column of data will make up the X-Axis.
  • DateTimeAxis: x-axis values are determined as time-based values such as hours, days, weeks, or years.


Configuring a Series (Y-Axis)

  • Click the "Add" button in the button toolbar of the Series DataGrid.
  • Repeat to add additional series.
  • Series may be removed with the "Remove" button next to the "Add" button.


Y-field

  • Values contained within the "Y-field" will determine the height for that series.
If you're using Sample.Data.ChartData, then select "Software" and "Hardware" as the Y-fields.


Form

Specifies the way in which the data series is shown in the chart. The following values are valid:

  • segment Draws lines as connected segments that are angled to connect at each data point in the series. This is the default.
  • step Draws lines as horizontal and vertical segments. At the first data point the chart draws a horizontal line, and then a vertical line to the second point. The chart repeats this action for each data point.
  • reverseStep Draws lines as horizontal and vertical segments. At the first data point the chart draws a vertical line, and then a horizontal line to the second point. The chart repeats this action for each data point.
  • vertical Draws only the vertical line from the y-coordinate of the first point to the y-coordinate of the second point at the x-coordinate of the second point. Repeats this action for each data point.
  • horizontal Draws only the horizontal line from the x-coordinate of the first point to the x-coordinate of the second point at the y-coordinate of the first point. Repeats this action for each data point.
  • curve Draws curves between data points.


Sample Area Chart Forms


Fill Style

  • Fill style is purely aesthetic, and sets the rendering style that will be used for the series.
  • The available rendering styles are Solid and Gradient.

Sample Area Chart


Color

  • Color will work in conjunction with Fill Style to distinguish one series from another.
  • You can select color by clicking on the color swatches in the color picker, or you can manually enter a hexadecimal color value.


Alpha

  • Alpha sets the opacity of the series.
  • Reducing the Alpha lets you see grid lines show through the columns.

Sample Area Alpha


Series Type

To select a different Series Type, click the pulldown in the bottom toolbar of the Series Data Grid.

  • overlaid: Chart elements for each series are rendered directly on top of each other, with the element corresponding to the last series on top. This is the default value for AreaChart controls.
  • stacked: Chart elements for each series are stacked cumulatively above each other. Each element represents the cumulative value of the elements beneath it.
  • 100%: Chart elements are stacked cumulatively above each other, adding up to 100%. Each chart element represents the percentage that the value contributes to the sum of the values for that category.

Sample Area Series Types


Additional Area Chart Options

  • Check or uncheck "Show Legend" as desired to include a legend of the line color for each Series (by Y-Field name).
  • Enable the X-Axis title and enter value as desired.
  • Enable the X-Axis labels and rotate them as desired.
  • Enable the Y-Axis title and enter value as desired.
  • Enable the Y-Axis labels and rotate them as desired.


Additional Configuration Steps


  • Enter the following information on the Actions tab:
    • Click Add Event Action to configure one or more Actions to be invoked when a user clicks on the Area Chart Widget. The action will apply to the current data record being displayed.


Sample Data

Instructions for bringing sample chart data into AppBoard can be found here: Sample Chart Data