Note

The Barcode Count mapping API is still in beta and may change in future versions of Scandit Data Capture SDK.

Barcode Spatial Grid

Defined in package com.scandit.datacapture.barcode.count.capture.map

BarcodeSpatialGridElement
class BarcodeSpatialGridElement

Added in version 7.1.0

Object representing an element in the grid presented by BarcodeSpatialGrid. Always contains a mainBarcode barcode property; may contain the optional subBarcode barcode property.

mainBarcode
val mainBarcode: Barcode

Added in version 7.1.0

The main barcode associated with the element.

subBarcode
val subBarcode: Barcode?

Added in version 7.1.0

The sub/tote barcode associated with the element, if present.

BarcodeSpatialGrid
class BarcodeSpatialGrid

Added in version 6.17.0

Object that is returned by BarcodeCountSession.getSpatialMap(). Represents the result of mapping the barcodes, and sub-barcodes if present, in a grid. Depending on the scanned barcodes the grid could be incomplete so for some coordinates the returned barcode could be null.

rows()
fun rows(): Int

Added in version 6.17.0

Returns the number of rows in the grid.

columns()
fun columns(): Int

Added in version 6.17.0

Returns the number of columns in the grid.

elementAt(row, column)
fun elementAt(row: Int,
        column: Int): BarcodeSpatialGridElement?

Added in version 7.1.0

Returns the element at the specified coordinates. If there is no element null is returned.

row(index)
fun row(index: Int): List<BarcodeSpatialGridElement?>

Added in version 7.1.0

Returns an array of elements corresponding to the selected row.

Missing elements in the row will be represented by null.

column(index)
fun column(index: Int): List<BarcodeSpatialGridElement?>

Added in version 7.1.0

Returns an array of elements corresponding to the selected column.

Missing elements in the row will be represented by null.

coordinatesForElement(element)
fun coordinatesForElement(element: BarcodeSpatialGridElement): List<Coordinate2d>

Added in version 7.1.0

Returns the list of coordinates for a specific element.

toJson()
fun toJson(): String

Added in version 6.19.0

Returns the JSON representation of the spatial grid.