Common Data Structures#

Geometric Types#

Defined in library scandit_datacapture_core

MeasureUnit#

Added in version 6.7.0

Specifies in what units the value has been specified (fraction, device-independent pixels, pixels).

dip#

Added in version 6.7.0

Value is measured in device-independent pixels.

pixel#

Added in version 6.7.0

Value is measured in pixels.

fraction#

Added in version 6.7.0

Value is measured as a fraction. Valid values range from 0 to 1. This can be used to specify values in relative coordinates with respect to a reference, e.g. the view width or height.

SizingMode#

Added in version 6.7.0

An enumeration of possible ways to define a rectangular size.

widthAndHeight#

Added in version 6.7.0

This value will use a SizeWithUnit to determine width and the height.

widthAndAspectRatio#

Added in version 6.7.0

This value will use a DoubleWithUnit to determine the width and a float multiplier to determine the height.

heightAndAspectRatio#

Added in version 6.7.0

This value will use a DoubleWithUnit to determine the height and a float multiplier to determine the width.

shorterDimensionAndAspectRatio#

Added in version 6.8.0

This value will use a DoubleWithUnit to determine the rectangle length on the short side of the reference and a float multiplier to determine the length on the long side.

Point#
class Point

Added in version 6.7.0

Point(x, y)#
 Point(double x,
        double y)

Added in version 6.7.0

Construct a new point at position x and y.

x#
double get x

Added in version 6.7.0

X coordinate of the point.

y#
double get y

Added in version 6.7.0

Y coordinate of the point.

PointWithUnit#
class PointWithUnit

Added in version 6.7.0

PointWithUnit(x, y)#
 PointWithUnit(DoubleWithUnit x,
        DoubleWithUnit y)

Added in version 6.7.0

Construct a new point at position x and y.

x#
final DoubleWithUnit x

Added in version 6.7.0

X coordinate of the point.

y#
final DoubleWithUnit y

Added in version 6.7.0

Y coordinate of the point.

SizeWithUnit#
class SizeWithUnit

Added in version 6.7.0

SizeWithUnit(width, height)#
 SizeWithUnit(DoubleWithUnit width,
        DoubleWithUnit height)

Added in version 6.7.0

Construct a new size with unit.

width#
DoubleWithUnit get width

Added in version 6.7.0

The width.

height#
DoubleWithUnit get height

Added in version 6.7.0

The height.

SizeWithAspect#
class SizeWithAspect

Added in version 6.7.0

Holds values to define a rectangular size using a dimension and an aspect ratio multiplier.

SizeWithAspect(size, aspect)#
 SizeWithAspect(DoubleWithUnit size,
        double aspect)

Added in version 6.7.0

Construct a new size with aspect.

size#
DoubleWithUnit get size

Added in version 6.7.0

The size of one dimension.

aspect#
double get aspect

Added in version 6.7.0

The aspect ratio for the other dimension.

DoubleWithUnit#
class DoubleWithUnit

Added in version 6.7.0

Holds a floating-point value plus a measure unit.

DoubleWithUnit(value, unit)#
DoubleWithUnit(double value,
        MeasureUnit unit)

Added in version 6.7.0

Construct a new float with unit.

value#
final double value

Added in version 6.7.0

unit#
final MeasureUnit unit

Added in version 6.7.0

MarginsWithUnit#
class MarginsWithUnit

Added in version 6.7.0

Holds margin values (left, top, right, bottom) that can each be expressed with a different measure unit.

MarginsWithUnit(left, top, right, bottom)#
 MarginsWithUnit(DoubleWithUnit left,
        DoubleWithUnit top,
        DoubleWithUnit right,
        DoubleWithUnit bottom)

Added in version 6.7.0

Constructs a new MarginsWithUnit instance.

left#
final DoubleWithUnit left

Added in version 6.7.0

Left margin.

right#
final DoubleWithUnit right

Added in version 6.7.0

Right margin.

top#
final DoubleWithUnit top

Added in version 6.7.0

Top margin.

bottom#
final DoubleWithUnit bottom

Added in version 6.7.0

Bottom margin.

Quadrilateral#
class Quadrilateral

Added in version 6.7.0

Polygon represented by 4 corners.

Quadrilateral(topLeft, topRight, bottomRight, bottomLeft)#
 Quadrilateral(Point topLeft,
        Point topRight,
        Point bottomRight,
        Point bottomLeft)

Added in version 6.7.0

Constructs a new Quadrilateral instance.

topLeft#
Point get topLeft

Added in version 6.7.0

topRight#
Point get topRight

Added in version 6.7.0

bottomRight#
Point get bottomRight

Added in version 6.7.0

bottomLeft#
Point get bottomLeft

Added in version 6.7.0

Size#
class Size

Added in version 6.7.0

Size(width, height)#
 Size(double width,
        double height)

Added in version 6.7.0

width#
double get width

Added in version 6.7.0

The width.

height#
double get height

Added in version 6.7.0

The height.

SizeWithUnitAndAspect#
class SizeWithUnitAndAspect

Added in version 6.7.0

Holds a SizingMode - and corresponding required values - to define a rectangular size.

SizeWithUnitAndAspect.widthAndHeight(widthAndHeight)#
SizeWithUnitAndAspect.widthAndHeight(SizeWithUnit widthAndHeight)

Added in version 6.7.0

Creates a rectangular size based on the given size.

SizeWithUnitAndAspect.widthAndAspectRatio(width, aspectRatio)#
SizeWithUnitAndAspect.widthAndAspectRatio(
        DoubleWithUnit width,
        double aspectRatio)

Added in version 6.7.0

Creates a rectangular size based on the given width and aspect ratio.

SizeWithUnitAndAspect.heightAndAspectRatio(height, aspectRatio)#
SizeWithUnitAndAspect.heightAndAspectRatio(
        DoubleWithUnit height,
        double aspectRatio)

Added in version 6.7.0

Creates a rectangular size based on the given height and aspect ratio.

SizeWithUnitAndAspect.shorterDimensionAndAspectRatio(fraction, aspectRatio)#
SizeWithUnitAndAspect.shorterDimensionAndAspectRatio(
        double fraction,
        double aspectRatio)

Added in version 6.8.0

Creates a rectangular size based on the given shorter dimension and aspect ratio.

widthAndHeight#
SizeWithUnit? get widthAndHeight

Added in version 6.7.0

The values for width and height.

Note

This value will always be null unless sizingMode is SizingMode.widthAndHeight.

widthAndAspectRatio#
SizeWithAspect? get widthAndAspectRatio

Added in version 6.7.0

The value for width and the aspect ratio for height.

Note

This value will always be null unless sizingMode is SizingMode.widthAndAspectRatio.

heightAndAspectRatio#
SizeWithAspect? get heightAndAspectRatio

Added in version 6.7.0

The value for height and the aspect ratio for width.

Note

This value will always be null unless sizingMode is SizingMode.heightAndAspectRatio.

shorterDimensionAndAspectRatio#
SizeWithAspect? get shorterDimensionAndAspectRatio

Added in version 6.8.0

The value for the short dimension of the reference view and the aspect ratio for the long dimension of the reference view.

Note

This value will always be null unless sizingMode is SizingMode.shorterDimensionAndAspectRatio.

sizingMode#
SizingMode get sizingMode

Added in version 6.7.0

The sizing mode.

Misc Types#

Defined in library scandit_datacapture_core

Defined in library scandit_datacapture_core

EncodingRange#
class EncodingRange

Added in version 6.7.0

Defines the encoding of a range of bytes.

EncodingRange(ianaName, startIndex, endIndex)#
 EncodingRange(String ianaName,
        int startIndex,
        int endIndex)

Added in version 6.7.0

Construct a new encoding range.

ianaName#
String get ianaName

Added in version 6.7.0

Charset encoding name as defined by IANA.

startIndex#
int get startIndex

Added in version 6.7.0

Start index of this encoding range.

endIndex#
int get endIndex

Added in version 6.7.0

End index (first index after the last) of this encoding range.

Defined in library scandit_datacapture_core

Orientation#

Added in version 6.7.0

unknown#

Added in version 6.7.0

portrait#

Added in version 6.7.0

portraitUpsideDown#

Added in version 6.7.0

landscapeRight#

Added in version 6.7.0

landscapeLeft#

Added in version 6.7.0

Defined in library scandit_datacapture_core