XlsGradientStop module

class XlsGradientStop.XlsGradientStop

Bases: SpireObject

Represents a gradient stop in an Excel gradient fill.

This class provides properties for manipulating individual color stops within a gradient, including position, color, transparency, tint, and shade. Each gradient stop defines a color at a specific position in the gradient.

property OColor: OColor

Gets the Office color object for the gradient stop.

Returns:

An Office color object representing the color of the gradient stop.

Return type:

OColor

property Position: int

Gets or sets the position of the gradient stop.

The position is a value between 0 and 100, representing the percentage position within the gradient.

Returns:

The position of the gradient stop (0-100).

Return type:

int

property Shade: int

Gets or sets the shade of the gradient stop color.

Shade is a positive value that darkens the color. The value represents the percentage of black added to the color.

Returns:

The shade value.

Return type:

int

property Tint: int

Gets or sets the tint of the gradient stop color.

Tint is a positive value that lightens the color. The value represents the percentage of white added to the color.

Returns:

The tint value.

Return type:

int

property Transparency: int

Gets or sets the transparency of the gradient stop.

The transparency is a value between 0 and 100, where 0 is fully opaque and 100 is fully transparent.

Returns:

The transparency value (0-100).

Return type:

int