# {py:mod}`arelle.utils.validate.ESEFImage`

```{py:module} arelle.utils.validate.ESEFImage
```

```{autodoc2-docstring} arelle.utils.validate.ESEFImage
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ImageValidationParameters <arelle.utils.validate.ESEFImage.ImageValidationParameters>`
  - ```{autodoc2-docstring} arelle.utils.validate.ESEFImage.ImageValidationParameters
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`validateImageAndLog <arelle.utils.validate.ESEFImage.validateImageAndLog>`
  - ```{autodoc2-docstring} arelle.utils.validate.ESEFImage.validateImageAndLog
    :summary:
    ```
* - {py:obj}`validateImage <arelle.utils.validate.ESEFImage.validateImage>`
  - ```{autodoc2-docstring} arelle.utils.validate.ESEFImage.validateImage
    :summary:
    ```
* - {py:obj}`checkImageContents <arelle.utils.validate.ESEFImage.checkImageContents>`
  - ```{autodoc2-docstring} arelle.utils.validate.ESEFImage.checkImageContents
    :summary:
    ```
* - {py:obj}`checkSVGContent <arelle.utils.validate.ESEFImage.checkSVGContent>`
  - ```{autodoc2-docstring} arelle.utils.validate.ESEFImage.checkSVGContent
    :summary:
    ```
* - {py:obj}`getHref <arelle.utils.validate.ESEFImage.getHref>`
  - ```{autodoc2-docstring} arelle.utils.validate.ESEFImage.getHref
    :summary:
    ```
* - {py:obj}`checkSVGContentElt <arelle.utils.validate.ESEFImage.checkSVGContentElt>`
  - ```{autodoc2-docstring} arelle.utils.validate.ESEFImage.checkSVGContentElt
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`_ <arelle.utils.validate.ESEFImage._>`
  - ```{autodoc2-docstring} arelle.utils.validate.ESEFImage._
    :summary:
    ```
````

### API

````{py:data} _
:canonical: arelle.utils.validate.ESEFImage._
:type: arelle.typing.TypeGetText
:value: >
   None

```{autodoc2-docstring} arelle.utils.validate.ESEFImage._
```

````

`````{py:class} ImageValidationParameters
:canonical: arelle.utils.validate.ESEFImage.ImageValidationParameters

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.ImageValidationParameters
```

````{py:attribute} checkMinExternalResourceSize
:canonical: arelle.utils.validate.ESEFImage.ImageValidationParameters.checkMinExternalResourceSize
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.ImageValidationParameters.checkMinExternalResourceSize
```

````

````{py:attribute} consolidated
:canonical: arelle.utils.validate.ESEFImage.ImageValidationParameters.consolidated
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.ImageValidationParameters.consolidated
```

````

````{py:attribute} contentOtherThanXHTMLGuidance
:canonical: arelle.utils.validate.ESEFImage.ImageValidationParameters.contentOtherThanXHTMLGuidance
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.ImageValidationParameters.contentOtherThanXHTMLGuidance
```

````

````{py:attribute} missingMimeTypeIsIncorrect
:canonical: arelle.utils.validate.ESEFImage.ImageValidationParameters.missingMimeTypeIsIncorrect
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.ImageValidationParameters.missingMimeTypeIsIncorrect
```

````

````{py:attribute} recommendBase64EncodingEmbeddedImages
:canonical: arelle.utils.validate.ESEFImage.ImageValidationParameters.recommendBase64EncodingEmbeddedImages
:type: bool
:value: >
   None

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.ImageValidationParameters.recommendBase64EncodingEmbeddedImages
```

````

````{py:attribute} supportedImgTypes
:canonical: arelle.utils.validate.ESEFImage.ImageValidationParameters.supportedImgTypes
:type: dict[bool, tuple[str, ...]]
:value: >
   None

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.ImageValidationParameters.supportedImgTypes
```

````

````{py:method} from_non_esef(checkMinExternalResourceSize: bool, missingMimeTypeIsIncorrect: bool, recommendBase64EncodingEmbeddedImages: bool, supportedImgTypes: dict[bool, tuple[str, ...]]) -> arelle.utils.validate.ESEFImage.ImageValidationParameters
:canonical: arelle.utils.validate.ESEFImage.ImageValidationParameters.from_non_esef
:classmethod:

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.ImageValidationParameters.from_non_esef
```

````

`````

````{py:function} validateImageAndLog(baseUrl: str | None, image: str, modelXbrl: arelle.ModelXbrl.ModelXbrl, val: arelle.ValidateXbrl.ValidateXbrl, elts: lxml.etree._Element | list[lxml.etree._Element], evaluatedMsg: str, params: arelle.utils.validate.ESEFImage.ImageValidationParameters, prelude: list[typing.Any] | None = None) -> None
:canonical: arelle.utils.validate.ESEFImage.validateImageAndLog

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.validateImageAndLog
```
````

````{py:function} validateImage(baseUrl: str | None, image: str, modelXbrl: arelle.ModelXbrl.ModelXbrl, val: arelle.ValidateXbrl.ValidateXbrl, elts: lxml.etree._Element | list[lxml.etree._Element], evaluatedMsg: str, params: arelle.utils.validate.ESEFImage.ImageValidationParameters) -> collections.abc.Iterable[arelle.utils.validate.Validation.Validation]
:canonical: arelle.utils.validate.ESEFImage.validateImage

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.validateImage
```
````

````{py:function} checkImageContents(baseURI: str | None, modelXbrl: arelle.ModelXbrl.ModelXbrl, imgElts: list[lxml.etree._Element], imgType: str, isFile: bool, data: bytes | str, params: arelle.utils.validate.ESEFImage.ImageValidationParameters, hasMimeType: bool, val: arelle.ValidateXbrl.ValidateXbrl) -> collections.abc.Iterable[arelle.utils.validate.Validation.Validation]
:canonical: arelle.utils.validate.ESEFImage.checkImageContents

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.checkImageContents
```
````

````{py:function} checkSVGContent(baseURI: str | None, modelXbrl: arelle.ModelXbrl.ModelXbrl, imgElts: list[lxml.etree._Element], data: bytes | str, params: arelle.utils.validate.ESEFImage.ImageValidationParameters, val: arelle.ValidateXbrl.ValidateXbrl) -> collections.abc.Iterable[arelle.utils.validate.Validation.Validation]
:canonical: arelle.utils.validate.ESEFImage.checkSVGContent

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.checkSVGContent
```
````

````{py:function} getHref(elt: lxml.etree._Element) -> str
:canonical: arelle.utils.validate.ESEFImage.getHref

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.getHref
```
````

````{py:function} checkSVGContentElt(elt: lxml.etree._Element, baseUrl: str | None, modelXbrl: arelle.ModelXbrl.ModelXbrl, imgElts: list[lxml.etree._Element], params: arelle.utils.validate.ESEFImage.ImageValidationParameters, val: arelle.ValidateXbrl.ValidateXbrl) -> collections.abc.Iterable[arelle.utils.validate.Validation.Validation]
:canonical: arelle.utils.validate.ESEFImage.checkSVGContentElt

```{autodoc2-docstring} arelle.utils.validate.ESEFImage.checkSVGContentElt
```
````