All Implemented Interfaces:

android.os.Parcelable
```
public final class ViewFinderConfiguration
extends BaseViewFinderConfiguration implements Parcelable
                    
```
Configuration of the scanning interface’s viewfinder, allowing it to be shown or hidden as guidance to the user.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`_type`
`private FinderStyle`	`style`
`private ScanbotColor`	`overlayColor`
`private AspectRatio`	`aspectRatio`
`private EdgeInsets`	`minimumInsets`
`private Double`	`preferredHeight`
`private Boolean`	`visible`

Constructor Summary

Constructors
Constructor	Description
`ViewFinderConfiguration(Map<String, Object> source)`
`ViewFinderConfiguration(JSONObject json)`
`ViewFinderConfiguration(FinderStyle style, ScanbotColor overlayColor, AspectRatio aspectRatio, EdgeInsets minimumInsets, Double preferredHeight, Boolean visible)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`get_type()`
`FinderStyle`	`getStyle()`	The visual appearance of the viewfinder.
`Unit`	`setStyle(FinderStyle style)`	The visual appearance of the viewfinder.
`ScanbotColor`	`getOverlayColor()`	The color of the viewfinder overlay.
`Unit`	`setOverlayColor(ScanbotColor overlayColor)`	The color of the viewfinder overlay.
`AspectRatio`	`getAspectRatio()`	The viewfinder's aspect ratio.
`Unit`	`setAspectRatio(AspectRatio aspectRatio)`	The viewfinder's aspect ratio.
`EdgeInsets`	`getMinimumInsets()`	The minimum insets of the viewfinder.
`Unit`	`setMinimumInsets(EdgeInsets minimumInsets)`	The minimum insets of the viewfinder.
`Double`	`getPreferredHeight()`	The preferred height of the viewfinder.
`Unit`	`setPreferredHeight(Double preferredHeight)`	The preferred height of the viewfinder.
`final Boolean`	`getVisible()`	Whether the viewfinder is visible.
`final Unit`	`setVisible(Boolean visible)`	Whether the viewfinder is visible.
`JSONObject`	`toJson(ToJsonConfiguration config)`
`ViewFinderConfiguration`	`clone()`
`final static ViewFinderConfiguration`	`default()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ViewFinderConfiguration

ViewFinderConfiguration(Map<String, Object> source)

ViewFinderConfiguration

ViewFinderConfiguration(JSONObject json)

ViewFinderConfiguration

ViewFinderConfiguration(FinderStyle style, ScanbotColor overlayColor, AspectRatio aspectRatio, EdgeInsets minimumInsets, Double preferredHeight, Boolean visible)

Method Detail
- get_type
```
 String get_type()
```
- getStyle
```
 FinderStyle getStyle()
```
  The visual appearance of the viewfinder.
- setStyle
```
 Unit setStyle(FinderStyle style)
```
  The visual appearance of the viewfinder.
- getOverlayColor
```
 ScanbotColor getOverlayColor()
```
  The color of the viewfinder overlay.
  Default is "?sbColorSurfaceLow"
- setOverlayColor
```
 Unit setOverlayColor(ScanbotColor overlayColor)
```
  The color of the viewfinder overlay.
  Default is "?sbColorSurfaceLow"
- getAspectRatio
```
 AspectRatio getAspectRatio()
```
  The viewfinder's aspect ratio.
- setAspectRatio
```
 Unit setAspectRatio(AspectRatio aspectRatio)
```
  The viewfinder's aspect ratio.
- getMinimumInsets
```
 EdgeInsets getMinimumInsets()
```
  The minimum insets of the viewfinder.
- setMinimumInsets
```
 Unit setMinimumInsets(EdgeInsets minimumInsets)
```
  The minimum insets of the viewfinder.
- getPreferredHeight
```
 Double getPreferredHeight()
```
  The preferred height of the viewfinder.
  Default is -1.0
- setPreferredHeight
```
 Unit setPreferredHeight(Double preferredHeight)
```
  The preferred height of the viewfinder.
  Default is -1.0
- getVisible
```
 final Boolean getVisible()
```
  Whether the viewfinder is visible.
  Default is true
- setVisible
```
 final Unit setVisible(Boolean visible)
```
  Whether the viewfinder is visible.
  Default is true
- toJson
```
 JSONObject toJson(ToJsonConfiguration config)
```
- clone
```
 ViewFinderConfiguration clone()
```
- default
```
 final static ViewFinderConfiguration default()
```

Class ViewFinderConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ViewFinderConfiguration

ViewFinderConfiguration

ViewFinderConfiguration

Method Detail

get_type

getStyle

setStyle

getOverlayColor

setOverlayColor

getAspectRatio

setAspectRatio

getMinimumInsets

setMinimumInsets

getPreferredHeight

setPreferredHeight

getVisible

setVisible

toJson

clone

default