Rectangle.fromXywh Method

Module: Rectangle

Definition

Creates an aligned rectangle from the top-left point and the width/height.

Python

@staticmethod
from_xywh(x: int, y: int, w: int, h: int) -> Rectangle

Parameters

x int

in X-coord of Top-left corner of the rectangle.

y int

in Y-coord of Top-left corner of the rectangle.

w int

in Width of the rectangle

h int

in Height of the rectangle.

Returns

Rectangle

The newly created rectangle.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

static Rectangle fromXywh(int x, int y, int w, int h)

Parameters

x int

in X-coord of Top-left corner of the rectangle.

y int

in Y-coord of Top-left corner of the rectangle.

w int

in Width of the rectangle

h int

in Height of the rectangle.

Returns

Rectangle

The newly created rectangle.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public static Rectangle FromXywh(int x, int y, int w, int h)

Parameters

x int

in X-coord of Top-left corner of the rectangle.

y int

in Y-coord of Top-left corner of the rectangle.

w int

in Width of the rectangle

h int

in Height of the rectangle.

Returns

Rectangle

The newly created rectangle.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public static Rectangle fromXywh(int x, int y, int w, int h) throws DocumentException

Parameters

x int

in X-coord of Top-left corner of the rectangle.

y int

in Y-coord of Top-left corner of the rectangle.

w int

in Width of the rectangle

h int

in Height of the rectangle.

Returns

Rectangle

The newly created rectangle.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public static func fromXywh(x: Int32, y: Int32, w: Int32, h: Int32) throws -> Rectangle

Parameters

x Int32

in X-coord of Top-left corner of the rectangle.

y Int32

in Y-coord of Top-left corner of the rectangle.

w Int32

in Width of the rectangle

h Int32

in Height of the rectangle.

Returns

Rectangle

The newly created rectangle.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentRectangle_FromXywh (
    ID3_DOCUMENT_RECTANGLE hRectangle,
    int x,
    int y,
    int w,
    int h)

Parameters

hRectangle ID3_DOCUMENT_RECTANGLE

in Handle to the Rectangle object.

x int

in X-coord of Top-left corner of the rectangle.

y int

in Y-coord of Top-left corner of the rectangle.

w int

in Width of the rectangle

h int

in Height of the rectangle.

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.