Source code for ooodev.format.inner.partial.chart2.area.chart_fill_img_partial

from __future__ import annotations
from typing import Any, TYPE_CHECKING

from ooodev.calc.chart2.partial.chart_doc_prop_partial import ChartDocPropPartial
from import ImgStyleKind
from ooodev.format.inner.style_factory import chart2_area_img_factory
from ooodev.utils.data_type.offset import Offset
from ooodev.format.inner.partial.default_factor_styler import DefaultFactoryStyler
from import EventsPartial

    from import XChartDocument
    from import XBitmap
    from ooodev.loader.inst.lo_inst import LoInst
    from ooodev.format.proto.chart2.area.chart_fill_img_t import ChartFillImgT
    from ooodev.format.inner.preset.preset_image import PresetImageKind
    from ooodev.format.inner.common.format_types.size_percent import SizePercent
    from ooodev.utils.data_type.size_mm import SizeMM
    from ooo.dyn.drawing.rectangle_point import RectanglePoint
    from ooodev.format.inner.common.format_types.offset_column import OffsetColumn
    from ooodev.format.inner.common.format_types.offset_row import OffsetRow
    XChartDocument = Any
    XBitmap = Any
    PresetImageKind = Any
    SizePercent = Any
    SizeMM = Any
    RectanglePoint = Any
    OffsetColumn = Any
    OffsetRow = Any

[docs]class ChartFillImgPartial: """ Partial class for Chart Fill Image. """
[docs] def __init__(self, factory_name: str, component: Any, lo_inst: LoInst | None = None) -> None: self.__styler = DefaultFactoryStyler( factory_name=factory_name, component=component, before_event="before_style_area_img", after_event="after_style_area_img", lo_inst=lo_inst, ) if isinstance(self, EventsPartial): self.__styler.add_event_observers(self.event_observer)
def _ChartFillImgPartial__get_chart_doc(self) -> XChartDocument: if isinstance(self, ChartDocPropPartial): return self.chart_doc.component raise NotImplementedError
[docs] def style_area_image( self, *, bitmap: XBitmap | None = None, name: str = "", mode: ImgStyleKind = ImgStyleKind.TILED, size: SizePercent | SizeMM | None = None, position: RectanglePoint | None = None, pos_offset: Offset | None = None, tile_offset: OffsetColumn | OffsetRow | None = None, auto_name: bool = False, ) -> ChartFillImgT | None: """ Style Area Color. Args: bitmap (XBitmap, optional): Bitmap instance. If ``name`` is not already in the Bitmap Table then this property is required. name (str, optional): Specifies the name of the image. This is also the name that is used to store bitmap in LibreOffice Bitmap Table. mode (~.write.fill.area.img.ImgStyleKind, optional): Specifies the image style, tiled, stretched etc. Default ``ImgStyleKind.TILED``. size (SizePercent, SizeMM, optional): Size in percent (``0 - 100``) or size in ``mm`` units. position (RectanglePoint): Tiling position of Image. pos_offset (Offset, optional): Tiling position offset. tile_offset (OffsetColumn, OffsetRow, optional): The tiling offset. auto_name (bool, optional): Specifies if ``name`` is ensured to be unique. Defaults to ``False``. Raises: CancelEventError: If the event ``before_style_area_img`` is cancelled and not handled. Returns: ChartFillImgT | None: Fill Image instance or ``None`` if cancelled. Hint: - ``RectanglePoint`` can be imported from ``ooo.dyn.drawing.rectangle_point`` - ``ImgStyleKind`` can be imported from ```` - ``SizePercent`` can be imported from ``ooodev.format.inner.common.format_types.size_percent`` - ``SizeMM`` can be imported from ``ooodev.utils.data_type.size_mm`` - ``OffsetColumn`` can be imported from ``ooodev.format.inner.common.format_types.offset_column`` - ``OffsetRow`` can be imported from ``ooodev.format.inner.common.format_types.offset_row`` - ``Offset`` can be imported from ``ooodev.utils.data_type.offset`` """ doc = self._ChartFillImgPartial__get_chart_doc() factory = chart2_area_img_factory kwargs = {"chart_doc": doc, "name": name, "mode": mode, "auto_name": auto_name} if bitmap is not None: kwargs["bitmap"] = bitmap if size is not None: kwargs["size"] = size if position is not None: kwargs["position"] = position if pos_offset is not None: kwargs["pos_offset"] = pos_offset if tile_offset is not None: kwargs["tile_offset"] = tile_offset return, **kwargs)
[docs] def style_area_image_get(self) -> ChartFillImgT | None: """ Gets the Area Area Image Style. Raises: CancelEventError: If the event ``before_style_area_img_get`` is cancelled and not handled. Returns: ChartFillImgT | None: Area image style or ``None`` if cancelled. """ doc = self._ChartFillImgPartial__get_chart_doc() return self.__styler.style_get(factory=chart2_area_img_factory, chart_doc=doc)
[docs] def style_area_image_from_preset(self, preset: PresetImageKind) -> ChartFillImgT | None: """ Style Area Gradient from Preset. Args: preset (PresetImageKind): Preset Image Kind. Returns: ChartFillImgT: Chart Fill Image instance. Hint: - ``PresetImageKind`` can be imported from ``ooodev.format.inner.preset.preset_image`` """ styler = self.__styler doc = self._ChartFillImgPartial__get_chart_doc() fe = self.__styler.style_get( factory=chart2_area_img_factory, call_method_name="from_preset", event_name_suffix="_from_preset", obj_arg_name="", chart_doc=doc, preset=preset, ) styler.style_apply(style=fe, chart_doc=doc, preset=preset) return fe