Skip to content

Image

Image

Bases: BaseFormItem

Data representing an image.

Source code in pygsuite/forms/generated/image.py
class Image(BaseFormItem):
    """
    Data representing an image.
    """

    def __init__(  # noqa: C901
        self,
        alt_text: Optional[str] = None,
        properties: Optional["MediaProperties"] = None,
        source_uri: Optional[str] = None,
        object_info: Optional[Dict] = None,
    ):
        generated: Dict = {}

        if alt_text is not None:

            generated["altText"] = alt_text
        if properties is not None:

            generated["properties"] = properties._info
        if source_uri is not None:

            generated["sourceUri"] = source_uri
        object_info = object_info or generated
        super().__init__(object_info=object_info)

    @property
    def alt_text(self) -> str:
        return self._info.get("altText")

    @alt_text.setter
    def alt_text(self, value: str):
        if self._info.get("altText", None) == value:
            return
        self._info["altText"] = value

    @property
    def content_uri(self) -> str:
        return self._info.get("contentUri")

    @property
    def properties(self) -> "MediaProperties":
        return MediaProperties(object_info=self._info.get("properties"))

    @properties.setter
    def properties(self, value: "MediaProperties"):
        if self._info.get("properties", None) == value:
            return
        self._info["properties"] = value

    @property
    def source_uri(self) -> str:
        return self._info.get("sourceUri")

    @source_uri.setter
    def source_uri(self, value: str):
        if self._info.get("sourceUri", None) == value:
            return
        self._info["sourceUri"] = value