Rectangular Location Selection

Defined in package com.scandit.datacapture.core.area

RectangularLocationSelection

class RectangularLocationSelection : LocationSelection

Added in version 6.0.0

Location selection for selecting codes inside a rectangle centered on the point of interest. Any object that is fully inside the rectangle is returned, objects that are partially or entirely outside of the rectangle are filtered out.

withSize(size)

static @NonNull RectangularLocationSelection withSize(
        @NonNull SizeWithUnit size)

Added in version 6.0.0

Creates a new rectangular location selection instance with the specified horizontal and vertical size. When the unit is relative (unit in either x or y is MeasureUnit.FRACTION) the size is computed relative to the view size minus the scan area margins.

withWidthAndAspectRatio(width, heightToWidthAspectRatio)

static @NonNull RectangularLocationSelection withWidthAndAspectRatio(
        @NonNull FloatWithUnit width,
        float heightToWidthAspectRatio)

Added in version 6.0.0

Creates a new rectangular location selection instance with the specified width and computes the height based on the provided height/width aspect ratio. When the unit is relative (MeasureUnit.FRACTION), the width is computed relative to the view size minus the scan area margins.

withHeightAndAspectRatio(height, widthToHeightAspectRatio)

static @NonNull RectangularLocationSelection withHeightAndAspectRatio(
        @NonNull FloatWithUnit height,
        float widthToHeightAspectRatio)

Added in version 6.0.0

Creates a new rectangular location selection instance with the specified height and computes the width based on the provided width/height aspect ratio. When the unit is relative (MeasureUnit.FRACTION), the height is computed relative to the view size minus the scan area margins.

sizeWithUnitAndAspect

@NonNull SizeWithUnitAndAspect getSizeWithUnitAndAspect()

Added in version 6.0.0

The size and sizing mode of the location selection.

toJson()

@NonNull String toJson()

Added in version 6.16.0

Returns the JSON representation of the location selection.