Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# DocumentDetector.documentWidthRatio Property

Module: DocumentDetector

Type: float

## Definition

Ratio of the estimated width of the searched document in the image.

Hint

Default value is 1.

Python

    document_width_ratio: float

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Dart

    double get documentWidthRatio => getDocumentWidthRatio();
    set documentWidthRatio(double value) => setDocumentWidthRatio(value);

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

C#

    public float documentWidthRatio
    {
        get => GetdocumentWidthRatio();
        set => SetdocumentWidthRatio(ref value);
    }

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Java

    public float getDocumentWidthRatio() throws DocumentException
    public void setDocumentWidthRatio(float documentWidthRatio) throws DocumentException

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Swift

    public var documentWidthRatio: Float
        get {
            return try! getDocumentWidthRatio()
        }
    }

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

C

    int id3DocumentDetector_GetDocumentWidthRatio (ID3_DOCUMENT_DETECTOR hDocumentDetector, float * documentWidthRatio)
    int id3DocumentDetector_SetDocumentWidthRatio (ID3_DOCUMENT_DETECTOR hDocumentDetector, float documentWidthRatio)

Returns

> `int`
> An error code.
> See id3DocumentError file for the list of possible error codes.