Zoom Switch Control
Defined under the namespace Scandit.Datacapture.Core.Ui
- ZoomSwitchControl
class ZoomSwitchControl : Control
Added in version 6.10.0
Control that allows switching between configurable camera zoom levels. The available zoom levels are filtered based on the camera hardware capabilities.
You can add this control to a view by calling DataCaptureView.addControl().
- constructor()
constructor()Added in version 8.3.0
Initializes a new ZoomSwitchControl.
- zoomedOutImage
zoomedOutImage: string | null
Added in version 6.10.0
Deprecated since version 8.4: This property is deprecated and will be removed in a future release.
The button image displayed when the zoom level is set to 1x.
- zoomedOutPressedImage
zoomedOutPressedImage: string | null
Added in version 6.10.0
Deprecated since version 8.4: This property is deprecated and will be removed in a future release.
The button image displayed when the zoom level is set to 1x and the button is pressed.
- zoomedInImage
zoomedInImage: string | null
Added in version 6.10.0
Deprecated since version 8.4: This property is deprecated and will be removed in a future release.
The button image displayed when the zoom level is set to 2x.
- zoomedInPressedImage
zoomedInPressedImage: string | null
Added in version 6.10.0
Deprecated since version 8.4: This property is deprecated and will be removed in a future release.
The button image displayed when the zoom level is set to 2x and pressed.
- setZoomedOutImage(resource)
setZoomedOutImage(resource: string):
voidAdded in version 6.23.0
Deprecated since version 8.4: This method is deprecated and will be removed in a future release.
The button image resource displayed when the zoom level is set to 1x.
- setZoomedOutPressedImage(resource)
setZoomedOutPressedImage(resource: string):
voidAdded in version 6.23.0
Deprecated since version 8.4: This method is deprecated and will be removed in a future release.
The button image resource displayed when the zoom level is set to 1x and the button is pressed.
- setZoomedInImage(resource)
setZoomedInImage(resource: string):
voidAdded in version 6.23.0
Deprecated since version 8.4: This method is deprecated and will be removed in a future release.
The button image resource displayed when the zoom level is set to 2x.
- setZoomedInPressedImage(resource)
setZoomedInPressedImage(resource: string):
voidAdded in version 6.23.0
Deprecated since version 8.4: This method is deprecated and will be removed in a future release.
The button image resource displayed when the zoom level is set to 2x and pressed.
- contentDescriptionWhenZoomedOut
contentDescriptionWhenZoomedOut: string |
nullAdded in version 8.3.0
Content description text used for the control button when zoomed out (Android only).
Note
This property is only used on Android. For iOS, use accessibilityLabelWhenZoomedOut instead.
- contentDescriptionWhenZoomedIn
contentDescriptionWhenZoomedIn: string |
nullAdded in version 8.3.0
Content description text used for the control button when zoomed in (Android only).
Note
This property is only used on Android. For iOS, use accessibilityLabelWhenZoomedIn instead.
- accessibilityLabelWhenZoomedOut
accessibilityLabelWhenZoomedOut: string |
nullAdded in version 8.3.0
Accessibility label text used for the control button when zoomed out (iOS only).
Note
This property is only used on iOS. For Android, use contentDescriptionWhenZoomedOut instead.
- accessibilityLabelWhenZoomedIn
accessibilityLabelWhenZoomedIn: string |
nullAdded in version 8.3.0
Accessibility label text used for the control button when zoomed in (iOS only).
Note
This property is only used on iOS. For Android, use contentDescriptionWhenZoomedIn instead.
- accessibilityHintWhenZoomedOut
accessibilityHintWhenZoomedOut: string |
nullAdded in version 8.3.0
Accessibility hint text used for the control button when zoomed out.
Note
This property is only used on iOS. Android does not have an equivalent accessibility hint concept.
- accessibilityHintWhenZoomedIn
accessibilityHintWhenZoomedIn: string |
nullAdded in version 8.3.0
Accessibility hint text used for the control button when zoomed in.
Note
This property is only used on iOS. Android does not have an equivalent accessibility hint concept.
- orientation
orientation: ZoomSwitchOrientation
Added in version 8.4.0
The orientation of the zoom switch control. Defaults to ZoomSwitchOrientation.Default.
- isAlwaysExpanded
isAlwaysExpanded: boolean
Added in version 8.4.0
When true, the control is always shown in its expanded state, displaying all zoom levels regardless of user interaction, and isExpanded is always true. When false, the control can be collapsed. Defaults to false.
- isExpanded
isExpanded: boolean
Added in version 8.4.0
Whether the control is currently expanded, showing all zoom levels. Can be set programmatically to expand or collapse the control. When isAlwaysExpanded is true, this property always returns true and setting it has no effect.
- selectedZoomLevel
get selectedZoomLevel(): number
Added in version 8.4.0
The currently selected zoom level.
- accessibilityLabel
accessibilityLabel: string
Added in version 8.4.0
The accessibility label. The placeholder
<level>is replaced with the zoom factor of each button. Defaults to"Zoom <level>".