ooodev.format.inner.direct.write.fill.area.gradient module

Module for Paragraph Gradient Color.

New in version 0.9.0.

class ooodev.format.inner.direct.write.fill.area.gradient.Gradient(*, style=GradientStyle.LINEAR, step_count=0, offset=Offset(x=50, y=50), angle=0, border=0, grad_color=ColorRange(start=0, end=16777215), grad_intensity=IntensityRange(start=100, end=100), name='')

Bases: StyleMulti

Paragraph Gradient Color

See also

• Write Direct Paragraph Area Gradient Class

New in version 0.9.0.

__init__(*, style=GradientStyle.LINEAR, step_count=0, offset=Offset(x=50, y=50), angle=0, border=0, grad_color=ColorRange(start=0, end=16777215), grad_intensity=IntensityRange(start=100, end=100), name='')

Constructor

Parameters:

• style (GradientStyle, optional) – Specifies the style of the gradient. Defaults to GradientStyle.LINEAR.

• step_count (int, optional) – Specifies the number of steps of change color. Defaults to 0.

• offset (Offset, int, optional) – Specifies the X and Y coordinate, where the gradient begins. X is effectively the center of the RADIAL, ELLIPTICAL, SQUARE and RECT style gradients. Defaults to Offset(50, 50).

• angle (Angle, int, optional) – Specifies angle of the gradient. Defaults to 0.

• border (int, optional) – Specifies percent of the total width where just the start color is used. Defaults to 0.

• grad_color (ColorRange, optional) – Specifies the color at the start point and stop point of the gradient. Defaults to ColorRange(Color(0), Color(16777215)).

• grad_intensity (IntensityRange, optional) – Specifies the intensity at the start point and stop point of the gradient. Defaults to IntensityRange(100, 100).

• name (str, optional) – Specifies the Fill Gradient Name.

Return type:

None

See also

• Write Direct Paragraph Area Gradient Class

copy()

copy(**kwargs)

copy(**kwargs)

Gets a copy of instance as a new instance

Return type:

TypeVar(_TGradient, bound= Gradient)

Parameters:

self (_TGradient) –

classmethod from_obj(obj)

classmethod from_obj(obj, **kwargs)

classmethod from_obj(obj, **kwargs)

Gets instance from object.

Parameters:

obj (object) – UNO object.

Raises:

NotSupportedError – If obj is not supported.

Returns:

Instance that represents Gradient color.

Return type:

Gradient

classmethod from_preset(preset)

classmethod from_preset(preset, **kwargs)

classmethod from_preset(preset, **kwargs)

Gets instance from preset.

Parameters:

preset (PresetGradientKind) – Preset.

Returns:

Gradient from a preset.

Return type:

Gradient

classmethod from_struct(struct, name='', **kwargs)

Gets instance from GradientStruct instance

Parameters:

• struct (GradientStruct) – Gradient Struct instance.

• name (str, optional) – Name of Gradient.

Return type:

Gradient

property default: _TGradient

Gets Gradient empty.

Return type:

TypeVar(_TGradient, bound= Gradient)

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_inner: GradientStruct

Gets Fill styles instance

Return type:

GradientStruct

property prop_name: str

Gets Current gradient Name

Return type:

str