ILNumerics - Technical Application Development
Assembly: ILNumerics.Toolboxes.Drawing2 (in ILNumerics.Toolboxes.Drawing2.dll) Version: 5.5.0.0 (5.5.7503.3146)
This constructor defines a stacked area plot on the basis of the arrays [!:X] and [!:Y].
[ILNumerics Drawing2 Toolbox]
Namespace: ILNumerics.Drawing.Plotting
Assembly: ILNumerics.Toolboxes.Drawing2 (in ILNumerics.Toolboxes.Drawing2.dll) Version: 5.5.0.0 (5.5.7503.3146)
Syntax
public StackedAreaPlot( InArray<float> X, InArray<float> Y, bool isLayeredAreaPlot = false, float spacing = 0,05f, Colormap colormap = null, Nullable<Color> lineColor = null, int lineWidth = 1, Nullable<Color> fillColor = null, Array<int> transparency = null, Object tag = null )
Parameters
- X
- Type: ILNumericsInArraySingle
X is a [1 x n] row vector. It contains the x coordinates for the area plots. - Y
- Type: ILNumericsInArraySingle
Y is a [m x n] matrix. For the stacked area plot, this matrix contains vertical distances. Here, each row is added to the previous row to create the stacked area plot. For the layered area plot, this matrix contains the vertical positions for each area plot. - isLayeredAreaPlot (Optional)
- Type: SystemBoolean
If set to true, a layered area plot is created, default: false. - spacing (Optional)
- Type: SystemSingle
[optional] Only for LayeredAreaPlots: Spacing defines the distance between the area plots on the Z-axis, default: 0.05. - colormap (Optional)
- Type: ILNumerics.Drawing.PlottingColormap
[optional] Colormap is used to map the positions of the area plots on the Z-axis. The Z positions are computed based on the input parameter [!:spacing]. Default: Colormaps.ILNumerics. - lineColor (Optional)
- Type: SystemNullableColor
[optional] Line color, default: Colormaps.ILNumerics. - lineWidth (Optional)
- Type: SystemInt32
[optional] Line Width, default: 1px. - fillColor (Optional)
- Type: SystemNullableColor
[optional] Fill Color. - transparency (Optional)
- Type: ILNumericsArrayInt32
[optional] Column vector that contains alpha values between 0 and 255 for each area plot. 0 indicates full transparency, while 255 represents no transparency. - tag (Optional)
- Type: SystemObject
[optional] identifies StackedAreaPlot in the scene graph, default: StackedAreaPlot.
Exceptions
Exception | Condition |
---|---|
ArgumentException | If input parameter X is empty. |
ArgumentException | If input parameter Y is empty. |
ArgumentException | If input parameter X is not a row vector. |
ArgumentException | If input parameter Y is not a matrix. |
ArgumentException | If input parameters X and Y do not have the same number of columns. |
ArgumentException | If input parameter transparency is not a column vector. |
ArgumentException | If input parameter transparency does not have same number of rows as the input parameter Y. |
ArgumentException | If input parameter spacing is less than 0. |
Remarks
Each row of Y and transparency describes a single area plot. Hence, Y and transparency must have a matching number of rows.
By default, both the fill areas and borders of the area plot are colored in on the basis of a colormap. By assigning a value to lineColor all lines receive the same color. The same applies to fillColor. Use transparency to better distinguish the area plots.
[ILNumerics Drawing2 Toolbox]
See Also