ChartElementLayout Class

Namespace:
GemBox.Spreadsheet.Charts
Assembly:
GemBox.Spreadsheet.dll

Represents a chart element`s custom positioning and sizing.

public class ChartElementLayout
Public Class ChartElementLayout
Inheritance:
System.Object
ChartElementLayout

Properties

Height

Gets or sets the height transformation applied to the chart element. Should always be a value from 0 to 1, representing a percentage of the chart's total height.

If HeightMode is set to Edge, this value will be used to set the right edge of the chart element (where the element vertically ends).

If HeightMode is set to Factor this value will be used to set the element's height.

public double? Height { get; set; }
Public Property Height As Double?
Property Value
System.Nullable<System.Double>
Remarks

In a scenario where Height is set to 0.25, this element is vertically positioned at 50px, inside a total chart area of 400px of height:
If HeightMode is Edge, the element will end at 100px (25% of 400px), since it starts at 50px, it will have 50px of height.
If HeightMode is Factor the element will now have 100px of height, since it starts at 50px, it will end at 150px.

HeightMode

Gets or sets the configuration of how Height should be interpreted. See Height for a more specific explanation.

public ChartElementLayoutMode HeightMode { get; set; }
Public Property HeightMode As ChartElementLayoutMode
Property Value
ChartElementLayoutMode

LayoutTarget

Gets or sets the configuration of whether to layout the plot area including axis and axis labels, which will all be fit inside the specified size and position (Outer) or whether to draw only the chart data (Inner).

Used only for ChartPlotArea.

public ChartElementLayoutTarget? LayoutTarget { get; set; }
Public Property LayoutTarget As ChartElementLayoutTarget?
Property Value
System.Nullable<ChartElementLayoutTarget>

Width

Gets or sets the width transformation applied to the chart element. Should always be a value from 0 to 1, representing a percentage of the chart's total width.

If WidthMode is set to Edge, this value will be used to set the right edge of the chart element (where the element horizontally ends).

If WidthMode is set to Factor this value will be used to set the element's width.

public double? Width { get; set; }
Public Property Width As Double?
Property Value
System.Nullable<System.Double>
Remarks

For example, in a scenario where Width is set to 0.25, this element is horizontally positioned at 50px, inside a total chart area of 400px of width:
If WidthMode is Edge, the element will end at 100px (25% of 400px), since it starts at 50px, it will have 50px of width.
If WidthMode is Factor the element will now have 100px of width, since it starts at 50px, it will end at 150px.

WidthMode

Gets or sets the configuration of how Width should be interpreted. See Width for a more specific explanation.

public ChartElementLayoutMode WidthMode { get; set; }
Public Property WidthMode As ChartElementLayoutMode
Property Value
ChartElementLayoutMode

X

Gets or sets the horizontal transformation applied to the chart element's position. Should always be a value from 0 to 1, representing a percentage of the chart's total width.

If XMode is set to Edge, this value will be used to set the left position of the chart element.

If XMode is set to Factor or null, the chart element's left position will be increased by this value.

public double? X { get; set; }
Public Property X As Double?
Property Value
System.Nullable<System.Double>
Remarks

For example, in a scenario where X is set to 0.25, this element is originally positioned at 50px, inside a total chart area of 400px of width:
If XMode is Edge, the element will now be positioned at 100px (25% of 400px).
If XMode is Factor or null, the element will now be positioned at 150px (original 50px plus 100px that represents 25% of the total area of 400px).

XMode

Gets or sets the configuration of how X should be interpreted. See X for a more specific explanation.

public ChartElementLayoutMode XMode { get; set; }
Public Property XMode As ChartElementLayoutMode
Property Value
ChartElementLayoutMode

Y

Gets or sets the vertical transformation applied to the chart element's position. Should always be a value from 0 to 1, representing a percentage of the chart's total height.

If YMode is set to Edge, this value will be used to set the top position of the chart element.

If YMode is set to Factor or null, the chart element's top position will be increased by this value.

public double? Y { get; set; }
Public Property Y As Double?
Property Value
System.Nullable<System.Double>
Remarks

For example, in a scenario where Y is set to 0.25, this element is originally positioned at 50px, inside a total chart area of 400px of height:
If YMode is Edge, the element will now be positioned at 100px (25% of 400px).
If YMode is Factor or null, the element will now be positioned at 150px (original 50px plus 100px that represents 25% of the total area of 400px).

YMode

Gets or sets the configuration of how Y should be interpreted. See Y for a more specific explanation.

public ChartElementLayoutMode YMode { get; set; }
Public Property YMode As ChartElementLayoutMode
Property Value
ChartElementLayoutMode