ooodev.format.proto.chart2.area.chart_fill_gradient_t module

protocol ooodev.format.proto.chart2.area.chart_fill_gradient_t.ChartFillGradientT[source]

Bases: FillGradientT, Protocol

Chart Fill Gradient Protocol

Classes that implement this protocol must have the following methods / attributes:

__init__(chart_doc, *, style=Ellipsis, step_count=Ellipsis, offset=Ellipsis, angle=Ellipsis, border=Ellipsis, grad_color=Ellipsis, grad_intensity=Ellipsis, name=Ellipsis)[source]

Constructor

Parameters:

  • chart_doc (XChartDocument) – Chart document.

  • 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

from_preset(chart_doc: XChartDocument, preset: PresetGradientKind) → ChartFillGradientT
from_preset(chart_doc: XChartDocument, preset: PresetGradientKind) → ChartFillGradientT
from_preset(**kwds)

Helper for @overload to raise when called.

classmethod from_struct(chart_doc, struct, name='', **kwargs)[source]

Gets instance from GradientStruct instance

Parameters:

  • chart_doc (XChartDocument) – Chart document.

  • struct (GradientStruct) – Gradient Struct instance.

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

Return type:

Gradient

__protocol_attrs__ = {'add_event_listener', 'add_event_observer', 'apply', 'backup', 'copy', 'default', 'from_obj', 'from_preset', 'from_struct', 'get_attrs', 'get_props', 'get_update_obj', 'has_update_obj', 'on_applied', 'on_applying', 'on_property_backed_up', 'on_property_backing_up', 'on_property_restore_set', 'on_property_restore_setting', 'on_property_set', 'on_property_set_error', 'on_property_setting', 'prop_format_kind', 'prop_has_attribs', 'prop_has_backup', 'prop_inner', 'prop_parent', 'remove_event_listener', 'remove_event_observer', 'restore', 'set_update_obj', 'support_service', 'update'}
property default: ChartFillGradientT

Gets Gradient empty.

Return type:

ChartFillGradientT