Home Search

DriveWorks Pro 22
Generate Column Chart

Send Feedback

Generate Column Chart

This Specification Macro Task will generate an image of a Column chart. The appearance and data of chart can be configured using the properties of the Task.

The plotting behavior is intended to be the same as plotting a chart in Microsoft Excel.

Properties

Mandatory Properties

Properties marked with a red asterisk (*) require a value to be entered.

This is identified on the task and is shown in the table below.

All other properties do not require a value for the task to run successfully.

Property NameDescription
TitleChanges the Title (not the name) of the Task.
Destination *The Full File Path and Name of the image file to create, including its extension.
OverwriteTRUE to overwrite the destination file, otherwise FALSE.
Image Width (px)The pixel width of the image to output.
Image Height (px)The pixel height of the image to output.
Table *A DriveWorks Table of data which will be plotted.

The first column of the Table will be used as the X plot. This column can be filled with text strings.

Every cell on the top row of each column of the Table will be used for series name. These cells be filled with text strings.

Every column thereafter the first will be used as the Y data plot. These cells can only contain numerical values.

Chart Title TextThe text that will be placed above the Chart. Can be left blank if no Title required.
Chart Title FontThe font string for the Chart Title.
Display LegendTRUE to display the Chart Legend. FALSE will not.
Chart Area BackColorThe color of the Chart Area background. The area in and around the Chart itself. Text and hex color values are accepted. Defaults to black if blank.
Image BackColorThe color of the Image background. The area not included in the Chart or legend. Text or Hexadecimal values accepted. Defaults to black if blank.
Chart Color Theme *The color theme of the Chart itself. Choose from one of the values in the list. See the chart below for examples.
Legend FontThe font used for the Legend.
Title colorThe color to use for the title. text, RGB or Hex values accepted. (Defaults to black if empty)
Display X Axis GridlinesTRUE to display X axis Gridlines. FALSE will not.
Display Y Axis GridlinesTRUE to display Y axis Gridlines. FALSE will not.
Display X Axis LabelsTRUE to display X Axis Labels. FALSE will not.
Display Y Axis LabelsTRUE to display Y Axis Labels. FALSE will not.
X Axis TitleThe text that will be placed along the X Axis of the Chart.
Y Axis TitleThe text that will be placed along the Y Axis of the Chart.
X Axis Title FontThe font used for the Y Axis Title.
Y Axis Title FontThe font used for the Y Axis Title.
X Axis Label FontThe font used for the X Axis Title.
Y Axis Label FontThe font used for the Y Axis Title.
Y Axis Minimum ValueThe minimum value for the Y Axis. If set to 0 the Axis will auto-scale.
Y Axis Maximum ValueThe maximum value for the Y Axis. If set to 0 the Axis will auto-scale.
Gridline ThicknessThe thickness of the chart gridlines (both X and Y).

Default is 0 (i.e. no gridlines)

When applying a gridline thickness above 0 you must have the Display X (or Y) Axis Gridlines properties enabled.
Gridline StyleChoose a gridline style from the list (both X and Y).

Options are:

  • Dash
  • DashDot
  • DashDotDot
  • Dot
  • Solid
Gridline ColorThe color of the gridlines. Text, RGB or Hex values accepted (defaults to black if empty)(both X and Y).
X Interval RateThe frequency of the X Axis Labels being printed. If set to 0 the interval will auto-scale
Y Interval RateThe frequency of the Y Axis Labels being printed. If set to 0 the interval will auto-scale

Example

When this Task is added the properties are static. To be able to build rules on a static properties see How To: Change A Static Property To A Dynamic Property.

Property NameExample RuleExample ResultMeaning
DestinationFsGetFullPath("<Specification>\CreatedChart.png")C:\MyDocuments\Projects\Specifications\Spec 9999\CreateChart.pngThis is the location where the new file will be created.
OverwriteTRUETRUETRUE will overwrite the file if it exists FALSE will not.
Image Width (px)600600This will be the new width in pixels of the image that will be created.
Image Height (px)400400This will be the new height in pixels of the image that will be created.
TableDwLookupGlobalTempatureDwLookupGlobalTempatureThis is the DriveWorks Table to look in for the data to use. This should be set out like the example below.
Chart Title Text"Average Global Temperatures" & NewLine() & "Source: NASA"

Average Global Temperatures

Source: NASA

This is the Charts name. The NewLine function simply adds the 'Source: NASA' part of the Title onto a new line.
Chart Title Font"font-family: calibri; font-size: 14pt; text-decoration: underline;"font-family: calibri; font-size: 14pt; text-decoration: underline;This is the font used for the Charts Title.
Display LegendFALSEFALSEFALSE will not display the Legend. TRUE would. The Legend will appear on the right side of the new image.
Chart Area BackColor"white"whiteThis is the color of the Chart Area background. The Value can be Text or Hexadecimal. Blank will default to black.
Image BackColor"white"whiteThis is the color of the Image background. The Value can be Text or Hexadecimal. Blank will default to black.
Chart Color Theme"BrightPastel"BrightPastelBrightPastel is one of the options themes that you can pick. Examples of other theme options can be seen below.
Legend Font"font-family: calibri; font-size: 11pt; text-decoration: underline;"font-family: calibri; font-size: 11pt; text-decoration: underline;This is the font to use for the Legend.
Title Color0|0|2550|0|255Will apply the RGB values to the title color.
Display X Axis GridlinesFALSEFALSEFALSE will not show the Gridlines. TRUE would.
Display Y Axis GridlinesFALSEFALSEFALSE will not show the Gridlines. TRUE would.
Display X Axis LabelsTRUETRUETRUE will show the X Axis Labels. FALSE would not.
Display Y Axis LabelsTRUETRUETRUE will show the Y Axis Labels. FALSE would not.
X Axis TitleYearsYearsThis is the Title of the X Axis.
Y Axis Title"Average Temperature °C"Average Temperature °CThis is the Title of the Y Axis.
X Axis Title Font"font-family: calibri; font-size: 11pt;"font-family: calibri; font-size: 11pt;This is the font to use for the X Axis Title.
Y Axis Title Font"font-family: calibri; font-size: 11pt;"font-family: calibri; font-size: 11pt;This is the font to use for the Y Axis Title.
X Axis Label Font"font-family: calibri; font-size: 11pt;"font-family: calibri; font-size: 11pt;This is the font to use for the X Axis Label.
Y Axis Label Font"font-family: calibri; font-size: 11pt;"font-family: calibri; font-size: 11pt;This is the font to use for the Y Axis Label.
Y Axis Minimum Value00The minimum value for the Y Axis. As it is set to 0 it will auto-scale.
Y Axis Maximum Value00The maximum value for the Y Axis. As it is set to 0 it will auto-scale.
Gridline Thickness11This will set the line thickness to 1.
Gridline StyleSolidSolidSets the gridline style to be Solid.
Gridline Color"LightGray"LightGraySets the gridline color to LightGray.
X Interval Rate00Will autoscale the X Axis label.
Y Interval Rate00Will autoscale the Y Axis label.

Example Table Data

The table below is an example of the data in a Simple Table referenced by the Table property above.

Simple Table Name: GlobalTemperature

YearAverage Temperature °C
19920.23
19930.24
19940.32
19950.46
19960.35
19970.48
19980.64
19990.42
20000.42
20010.55
20020.63
20030.62
20040.55
20050.69
20060.63
20070.66
20080.54
20090.64
20100.71
20110.6
20120.63
20130.65
20140.74
20150.87
20160.99
20170.90

Example Chart Color Theme Property

The table below shows examples of values for the Chart Color Theme property above.

Chart Color ThemeArea ChartColumn ChartLine ChartPie Chart
Berry
Bright
BrightPastel
Chocolate
EarthTones
Excel
Fire
Grayscale
Light
None
Pastel
SeaGreen
SemiTransparent

Using the Task in a Specification Macro

This task has different types of Outputs. For more information about Outputs see Specification Macros Task Node.

Outputs are only available within Specification Macros. Currently Outputs are not available for Specification Flow.

Status Outputs

This task supports Status Outputs. These can be used to perform different actions depending on what the status outcome of the task is. For more information see Status Outputs in the Task Node Outputs section of Specification Macros Task Node.

Success

  • Chart successfully created.

Success with Warnings

  • N/A - should never be fulfilled.

Failed (one of the following occurred)

  • Y Axis maximum value cannot be less than or equal to the minimum value.
  • Table cannot be empty
  • Invalid input. Image width must be greater than or equal to 1.
  • Invalid input. Image height must be greater than or equal to 1.
  • Chart Color Theme is not a valid theme. Please use one of the listed values.
  • Destination path cannot be empty.
  • Unknown error. See the Specification report for more details.
© DriveWorks Ltd 2024 - All rights reserved.
Privacy Policy | Terms & Conditions