Back to Devexpress

ShapeGradientFill Interface

officefileapi-devexpress-dot-spreadsheet-dot-drawings-6880ee31.md

latest7.2 KB
Original Source

ShapeGradientFill Interface

Defines the settings of the gradient fill applied to a chart element.

Namespace : DevExpress.Spreadsheet.Drawings

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
public interface ShapeGradientFill :
    ShapeComplexFill
vb
Public Interface ShapeGradientFill
    Inherits ShapeComplexFill

The following members return ShapeGradientFill objects:

Remarks

To access an object exposing the ShapeGradientFill interface, use the ShapeOutlineFill.GradientFill property.

To apply a gradient fill to a chart element, call the ShapeOutlineFill.SetGradientFill method. Then, use the ShapeGradientFill object’s properties to adjust the gradient settings (to add additional gradient stops by utilizing the ShapeGradientFill.Stops property, set the angle of the gradient fill by using the ShapeGradientFill.Angle property or specify a region of the chart element to which the gradient is applied via the ShapeGradientFill.TileRect property).

The ShapeGradientFill interface inherits the specific fill options from the ShapeComplexFill interface. These options allow you to set the gradient direction (ShapeComplexFill.FillRect) and specify whether the fill should be rotated with the shape (ShapeComplexFill.RotateWithShape).

Example

The example below demonstrates how to create a clustered column chart and adjust its appearance. First, add the chart title and change the font color via the ShapeTextFont.Color property. Make the plot area transparent by using the ShapeOutlineFill.SetNoFill method, and then apply the gradient fill to the chart area by utilizing the ShapeOutlineFill.SetGradientFill method. To set the picture fill for all columns in a chart, call the ShapeFill.SetPictureFill method for a series object. Finally, change the color of the primary axes by utilizing the ShapeOutlineFill.SetSolidFill method and specify the axis width via the ShapeOutline.Width property.

View Example: Spreadsheet Chart API

csharp
Worksheet worksheet = workbook.Worksheets["chartTask7"];
workbook.Worksheets.ActiveWorksheet = worksheet;

// Create a chart and specify its location.
Chart chart = worksheet.Charts.Add(ChartType.ColumnClustered, worksheet["B2:C8"]);
chart.TopLeftCell = worksheet.Cells["F2"];
chart.BottomRightCell = worksheet.Cells["N17"];

// Add and format the chart title.
chart.Title.SetValue("Countries with the largest forest area");
chart.Title.Font.Color = Color.FromArgb(0x34, 0x5E, 0x25);

// Set no fill for the plot area.
chart.PlotArea.Fill.SetNoFill();

// Apply the gradient fill to the chart area.
chart.Fill.SetGradientFill(ShapeGradientType.Linear, Color.FromArgb(0xFD, 0xEA, 0xDA), Color.FromArgb(0x77, 0x93, 0x3C));
ShapeGradientFill gradientFill = chart.Fill.GradientFill;
gradientFill.Stops.Add(0.78f, Color.FromArgb(0xB7, 0xDE, 0xE8));
gradientFill.Angle = 90;

// Set the picture fill for the data series.
chart.Series[0].Fill.SetPictureFill("Pictures\\PictureFill.png");

// Customize the axis appearance.
AxisCollection axisCollection = chart.PrimaryAxes;
foreach (Axis axis in axisCollection)
{
    axis.MajorTickMarks = AxisTickMarks.None;
    axis.Outline.SetSolidFill(Color.FromArgb(0x34, 0x5E, 0x25));
    axis.Outline.Width = 1.25;
}
// Change the scale of the value axis.
Axis valueAxis = axisCollection[1];
valueAxis.Scaling.AutoMax = false;
valueAxis.Scaling.Max = 8000000;
valueAxis.Scaling.AutoMin = false;
valueAxis.Scaling.Min = 0;
// Specify display units for the value axis.
valueAxis.DisplayUnits.UnitType = DisplayUnitType.Thousands;
valueAxis.DisplayUnits.ShowLabel = true;

// Hide the legend.
chart.Legend.Visible = false;
vb
Dim worksheet As Worksheet = workbook.Worksheets("chartTask7")
workbook.Worksheets.ActiveWorksheet = worksheet

' Create a chart and specify its location.
Dim chart As Chart = worksheet.Charts.Add(ChartType.ColumnClustered, worksheet("B2:C8"))
chart.TopLeftCell = worksheet.Cells("F2")
chart.BottomRightCell = worksheet.Cells("N17")

' Add and format the chart title.
chart.Title.SetValue("Countries with the largest forest area")
chart.Title.Font.Color = Color.FromArgb(&H34, &H5E, &H25)

' Set no fill for the plot area.
chart.PlotArea.Fill.SetNoFill()

' Apply the gradient fill to the chart area.
chart.Fill.SetGradientFill(ShapeGradientType.Linear, Color.FromArgb(&HFD, &HEA, &HDA), Color.FromArgb(&H77, &H93, &H3C))
Dim gradientFill As ShapeGradientFill = chart.Fill.GradientFill
gradientFill.Stops.Add(0.78F, Color.FromArgb(&HB7, &HDE, &HE8))
gradientFill.Angle = 90

' Set the picture fill for the data series.
chart.Series(0).Fill.SetPictureFill("Pictures\PictureFill.png")

' Customize the axis appearance.
Dim axisCollection As AxisCollection = chart.PrimaryAxes
For Each axis As Axis In axisCollection
    axis.MajorTickMarks = AxisTickMarks.None
    axis.Outline.SetSolidFill(Color.FromArgb(&H34, &H5E, &H25))
    axis.Outline.Width = 1.25
Next axis
' Change the scale of the value axis.
Dim valueAxis As Axis = axisCollection(1)
valueAxis.Scaling.AutoMax = False
valueAxis.Scaling.Max = 8000000
valueAxis.Scaling.AutoMin = False
valueAxis.Scaling.Min = 0
' Specify display units for the value axis.
valueAxis.DisplayUnits.UnitType = DisplayUnitType.Thousands
valueAxis.DisplayUnits.ShowLabel = True

' Hide the legend.
chart.Legend.Visible = False

See Also

ShapeGradientFill Members

DevExpress.Spreadsheet.Drawings Namespace