ooodev.format.inner.modify.write.frame.area.gradient module
- class ooodev.format.inner.modify.write.frame.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='', style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]
Bases:
FrameStyleBaseMulti
Frame Style Area Gradient.
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='', style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]
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 is effectively the center of the
RADIAL
,ELLIPTICAL
,SQUARE
andRECT
style gradients. Defaults toOffset(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.
style_name (StyleFrameKind, str, optional) – Specifies the Frame Style that instance applies to. Default is Default Frame Style.
style_family (str, optional) – Style family. Default
FrameStyles
.
- Return type:
None
- classmethod from_preset(preset, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]
Gets instance from preset.
- Parameters:
preset (PresetGradientKind) – Preset.
style_name (StyleFrameKind, str, optional) – Specifies the Frame Style that instance applies to. Default is Default Frame Style.
style_family (str, optional) – Style family. Default
FrameStyles
.
- Returns:
Gradient
instance from a preset.- Return type:
- classmethod from_style(doc, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]
Gets instance from Document.
- Parameters:
doc (object) – UNO Document Object.
style_name (StyleFrameKind, str, optional) – Specifies the Frame Style that instance applies to. Default is Default Frame Style.
style_family (str, optional) – Style family. Default
FrameStyles
.
- Returns:
Gradient
instance from style properties.- Return type:
- property prop_style_name: str
Gets/Sets property Style Name
- Return type:
str