Area - Data360_Analyze - 3.12

Properties

Type

Specify the type of chart to produce (this property can be ignored if you are using a single series). Choose from:

• Percentage - Creates an Area chart where the different series are plotted one on top of the other showing the percentage that each series contributes to the total value for each X-axis value.
• Stacked - Creates a stacked Area chart where the different series are placed one on top of the other.

The default value is Stacked.

Title

Specify a title for the chart.

A value is required for this property.

XAxisField

Specify the name of a single field that determines the values on the X axis. The type of this field may be string, unicode, int, long, double, date, time, or datetime.

A value is required for this property.

YAxisFields

Specify the name of a field or list of fields that contain the values for the Y axis.

If the SeriesField property is defined, then you must only enter a single field in the YAxisFields property. If the SeriesField property is not defined, then you may enter multiple fields in the YAxisFields property. If you enter multiple fields, you can use deterministic wildcards "?" and "*". All fields referenced in this property must have the same type and must be of type int, long, double, date, time, or datetime.

The order that fields are matched in this field is the same for all runs, even if the entire data flow is rerun or if wildcards are used. The only time that fields will be reordered is if you add or remove fields in nodes prior to this one. You can use this ordering to determine the order in which the series are displayed in the final chart.

A value is required for this property.

SeriesField

Optionally specify a single field that determines the name of the series for each data point. If this field is blank, then the series names are the names of the fields specified in the YAxisFields property. The type of this field may be string, unicode, int, long, date, time, or datetime.

FocusSeriesFilter

Optionally specify a list of values; either enter exact field names or strings with "*" or "?" wildcards. Using these fields, this property defines a string filter on the series name whose matches are displayed in entirety while the rest of the values are summed and displayed as a single series.

FocusSeriesNumber

Optionally specify a positive, integer value to define the maximum number of series that will be displayed in their entirety. The smallest series will be summed and displayed as a single series while the largest series will be displayed entirely.

FocusXAxisFilter

Optionally specify a list of values; either enter exact field matches or strings with a "*" or "?" wildcard. Using these fields, this property defines a string filter on the X-axis labels whose matches are displayed in entirety while the rest of the values are summed and displayed as a single entry.

FocusXAxisNumber

Optionally specify a positive, integer value to define the maximum number of X-axis entries that will be displayed in their entirety. The smallest entries will be summed and displayed as a single entry while the largest entries will be displayed entirely.

ShowNonfocusedSeries

Optionally specify whether the 'All Others' series is displayed when you turn on series focusing. If set to False, the 'All Others' series is not displayed. If you have focusing turned on in both directions, and if this property is set to False, then the point where both the X-axis value and the Series is summarized, that is the 'All Others-All Others' point, is removed. If series focusing is turned off, then this property has no effect.

The default value is True.

ShowNonfocusedXAxis

Optionally specify whether the 'All Others' X-axis entry is displayed when the you turn on X-axis focusing. If set to False, that X-axis entry is hidden. If you have focusing turned on in both directions and if this property is set to False, then the point where both the X-axis value and the Series is summarized, that is the 'All Others-All Others' point, is removed. If X-axis focusing is turned off, then this property has no effect.

The default value is True.

DisplayOrder

Optionally specify the name of the fields that you want to sort the input and output data by. This feature is useful when the XAxisField is string or Unicode since you can then sort the input data in different ways other than just alphabetical order. If the field data is of a numeric type, then the chart will simply display it in numerical order regardless of how it is input. If this field is blank, then a sort is not performed.

Enter the column names in the order that you want to sort on, separated by a comma. You can enter as many fields as you want and reverse any number of the specified fields by using the Script .reverse() function. To sort by multiple columns in descending order, use the following format where value is the name of the input fields that you want to sort by:reverse (list(value_1, value_2, value_3))

This property uses the same syntax as the CompareOrderExpr property in a Sort node.

YAxisLabel

Optionally specify a value for the text of the y-axis label.

If the YAxisLabel property is not populated and the YAxisFields property contains a single value, this value will be used. If the YAxisLabel property is not populated and the YAxisFields property contains more than one value, then the YAxisLabel is left blank.

Labeltemplate

Optionally specify a template for labels that are applied to all chart types except Area. These templates can contain regular text or the charted values themselves. In order to place the X-axis value, Y-axis value, and series name in the template, use "#X", "#Y", and "#Series". All other text containing "#" is left as is along with any text not prefixed with "#".

If you leave this property blank, labels for all chart types are turned off. Note that Area charts only supports labels if the X-axis data is not numeric.

DisplayLegend

Optionally specify whether to display the legend.

The default value is True.

imagesize

Optionally specify the size of the image to be output.

The default is set by your server administrator, for example: 1024, 768.

FieldColors

Optionally specify one or more statements, in the following format, to override the default colors of all the elements in a series:

Series=Color

Wildcards are allowed and the following colors are accepted: black, blue, cyan, darkgray, gray, green, lightgray, magenta, orange, pink, red, white, and yellow. Color names are not case-sensitive.

If this property is left blank, then only the default colors are used. The statements specified in the FieldColors property will be run in the order that they are specified, therefore it is important to ensure that you do not write the statements in an order that causes one to overwrite the other.

For example, to highlight a single series named "Data360" in magenta, and keep all other elements in the chart using the default colors, enter:

Data360=Magenta

You can ensure that your highlighting stands out by manually setting all other elements to a more sedate color, as in the following example:

*=GrayData360=Magenta

Note that in this example, the gray statement comes first, followed by the magenta statement. This ensures that the gray statement first sets all series to the color gray, then the magenta statement colors only the "Data360" series. As a counterexample, if the statements were reversed then all of the elements would be colored gray (the first line will color the Data360 series magenta, but then the second line will overwrite all series with gray), as follows:

Data360=Magenta*=Gray

CheckDuplicates

Optionally specify whether the node will fail if duplicates are detected. A duplicate is defined as two or more points that have the same X-axis value and Series name.

If set to false, if the input data contains duplicates, the behavior of this node is completely undefined: it may error, it may display only the last instance of the duplicates, or it may display all duplicates.

This property allows you to optimize a chart node by turning off duplicate detection.

XAxisRange

Optionally specify the range of the numeric scale of the X Axis in the following format:

<lower limit> - <upper limit>

This option cannot be used if the X Axis is specified by string data. In addition to standard numeric types, this option specifically supports dates, times, and datetimes. It is unavailable for pie or radar charts.

For time data, the XAxisRange must be in the following format:

hh:mm:ss - hh:mm:ss

For date data, the format is as follows:

CCYY-MM-DD - CCYY-MM-DD

For datetime data, the format is as follows:

CCYY-MM-DD hh:mm:ss - CCYY-MM-DD hh:mm:ss

If this property is blank, the chart's X axis is automatically set to display all input data. This property is not applicable in Pie and Radar charts.

YAxisRange

Optionally specify the range of the numeric scale of the Y Axis in the following format:

<lower range> - <upper range>

This option cannot be used if the Y Axis is specified by string data. In addition to standard numeric types, this option specifically supports dates, times, and datetimes. It is unavailable for pie or radar charts.

For time data, the YAxisRange must be in the following format:

hh:mm:ss - hh:mm:ss

For date data, the format is as follows:

CCYY-MM-DD - CCYY-MM-DD

For datetime data, the format is as follows:

CCYY-MM-DD hh:mm:ss - CCYY-MM-DD hh:mm:ss

If this property is blank, the chart's Y axis is automatically set to display all input data.

NullValueBehavior

Optionally specify how to handle NULL values in the X-axis, Y-axis, or diameter, if present. Choose from:

• Error - The node fails if there are any NULLvalues.
• Set to Zero - Any NULL value is treated as a zero value. Date values are set to 1900-01-01, and time values are set to midnight. Datetimes are set to 1900-01-01 00:00:00.
• Suppress Point - Removes NULL values in any field.

The default value is Set to Zero.

Inputs and outputs

Inputs: Input Data, Multiple optional.

Outputs: Prepared Data, Chart Data, Chart, Multiple optional.