CreateLinearGradientFill
Creates a linear gradient fill to apply to the object using the selected linear gradient as the object background.
Syntax
expression.CreateLinearGradientFill(gradientStops, angle);
expression - A variable that represents a Api class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| gradientStops | Required | number[] | The array of gradient color stops measured in 1000th of percent. | |
| angle | Required | PositiveFixedAngle | The angle measured in 60000th of a degree that will define the gradient direction. |
Returns
Example
This example creates a linear gradient fill to apply to the object using the selected linear gradient as the object background.
- Code
- Result
// How to create a linear gradient fill to set it as a drawing background.
// Change a drawing background using gradient fill.
const doc = Api.GetDocument();
const page = doc.GetPage(0);
const gs1 = Api.CreateGradientStop(Api.RGB(255, 213, 191), 0);
const gs2 = Api.CreateGradientStop(Api.RGB(255, 111, 61), 100000);
const fill = Api.CreateLinearGradientFill([gs1, gs2], 5400000);
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const drawing = Api.CreateShape("flowChartMagneticTape", 150 * 36000, 65 * 36000, fill, stroke);
drawing.SetPosition(608400, 1267200);
page.AddObject(drawing);