class · iOS 16.0+ · SDK 27.1
@MainActor @objc final class ImageAnalysisInteractionAn interface that enables people to interact with recognized text, barcodes, and other objects in an image. This class enables people to interact with specific content types (``ImageAnalysisInteraction/InteractionTypes``) that the framework identifies in an image. For example: - The Live Text interface enables them to select any text present in the image (``ImageAnalysisInteraction/InteractionTypes/textSelection``), or invoke a URL (``ImageAnalysisInteraction/InteractionTypes/dataDetectors``). The text selection UI offers framework-standard buttons for copying selected text, or looking it up on the web for more information. - The *subject lift* feature identifies a wide variety of objects, or *subjects*, in images with the ``ImageAnalysisInteraction/InteractionTypes/imageSubject`` interaction type, and provides your app with an image of the objects with the background removed. The ``ImageAnalysisInteraction/InteractionTypes/visualLookUp`` type supplements this feature by adding a button in the bottom corner of the view that people can click or tap for more information about the recognized subjects. ## Configure the interface and begin interaction This class conforms to the <doc://com.apple.documentation/documentation/uikit/uiinteraction> protocol. To connect the interface with an image that your app displays, call <doc://com.apple.documentation/documentation/uikit/uiview/2891013-addinteraction> on your app's image view and pass in a new instance of this class. Choose the items that the framework recognizes in an image by configuring the ``ImageAnalysisInteraction/preferredInteractionTypes`` property. To recognize all types of content, specify the ``ImageAnalysisInteraction/InteractionTypes/automatic`` option, or choose a combination of types by assigning an array: ```swift interaction.preferredInteractionTypes = [.textSelection, .imageSubject] ``` To begin interaction, call one of the ``ImageAnalyzer`` class's `analyze` methods, such as ``ImageAnalyzer/analyze(_:configuration:)`` and set the result onto this class's ``ImageAnalysisOverlayView/analysis`` property. You can take more control over the interaction or provide details about your app's image view by implementing a delegate (``ImageAnalysisInteractionDelegate``) and assigning it to the ``ImageAnalysisInteraction/delegate`` property. If your image view isn't an instance of <doc://com.apple.documentation/documentation/uikit/uiimageview>, your app needs to define the interactive area within the image by implementing the ``ImageAnalysisInteractionDelegate/contentsRect(for:)-187x`` method.
didMove(view?: (_UIKit_UIView) | null): Promise<void>@MainActor @preconcurrency final func didMove(to view: UIView?)Performs an action after the view adds or removes the interaction from its interaction array. - Parameter view: The view that owns and contains the interaction in its interaction array.
static init(): Promise<ImageAnalysisInteraction>@MainActor override dynamic init()Creates an interaction for Live Text actions with items in an image.
willMove(view?: (_UIKit_UIView) | null): Promise<void>@MainActor @preconcurrency final func willMove(to view: UIView?)Performs an action before the view adds or removes the interaction from its interaction array. - Parameter view: The view that owns and contains the interaction in its interaction array.
get view(): Promise<(_UIKit_UIView) | null>@MainActor @preconcurrency weak final var view: UIView? { get }The view that uses this interaction.
get activeInteractionTypes(): Promise<ImageAnalysisInteraction_InteractionTypes>@MainActor final var activeInteractionTypes: ImageAnalysisInteraction.InteractionTypes { get }The types of interactions that a person actively performs. This property is always a concrete type that’s never set to ``ImageAnalysisInteraction/InteractionTypes/automatic``.
get preferredInteractionTypes(): Promise<ImageAnalysisInteraction_InteractionTypes>@MainActor final var preferredInteractionTypes: ImageAnalysisInteraction.InteractionTypes { get set }The types of interactions that people can perform with the image. You need to set this property to enable interactions with the image. If this property contains ``ImageAnalysisInteraction/InteractionTypes/automatic``, the interaction ignores the other types in the set. The default value for this property is an empty array that disables any interactions. If you set this property to one or more types, the interaction sets the view’s <doc://com.apple.documentation/documentation/uikit/uiview/1622577-isuserinteractionenabled> property to `true` so that the interaction begins. For example, when you’re ready to start the Live Text interface, set this property to ``ImageAnalysisInteraction/InteractionTypes/automatic``. If you set this property to an empty array, the image analysis interaction doesn’t reset the view’s `isUserInteractionEnabled` property to `false`.
setPreferredInteractionTypes(value: ImageAnalysisInteraction_InteractionTypes): Promise<void>@MainActor final var preferredInteractionTypes: ImageAnalysisInteraction.InteractionTypes { get set }The types of interactions that people can perform with the image. You need to set this property to enable interactions with the image. If this property contains ``ImageAnalysisInteraction/InteractionTypes/automatic``, the interaction ignores the other types in the set. The default value for this property is an empty array that disables any interactions. If you set this property to one or more types, the interaction sets the view’s <doc://com.apple.documentation/documentation/uikit/uiview/1622577-isuserinteractionenabled> property to `true` so that the interaction begins. For example, when you’re ready to start the Live Text interface, set this property to ``ImageAnalysisInteraction/InteractionTypes/automatic``. If you set this property to an empty array, the image analysis interaction doesn’t reset the view’s `isUserInteractionEnabled` property to `false`.
get contentsRect(): Promise<{ x: number; y: number; width: number; height: number }>@MainActor final var contentsRect: CGRect { get }A rectangle, in unit coordinate space, that describes the content area of the interaction. If the interaction’s view isn't an instance of <doc://com.apple.documentation/documentation/uikit/uiimageview>, your app sets the value for this property by implementing the ``VisionKit/ImageAnalysisInteractionDelegate`` callback ``VisionKit/ImageAnalysisInteractionDelegate/contentsRect(for:)-187x``. The default return value is the unit rectangle, `[0.0, 0.0, 1.0, 1.0]`, which represents the whole view contents.
get selectedText(): Promise<string>@MainActor final var selectedText: String { get }The current selected text.
get selectedRanges(): Promise<Array<SDKHandle>>@MainActor final var selectedRanges: [Range<String.Index>] { get set }Sets selected text ranges.
setSelectedRanges(value: Array<SDKHandle>): Promise<void>@MainActor final var selectedRanges: [Range<String.Index>] { get set }Sets selected text ranges.
analysisHasText(point: { x: number; y: number }): Promise<boolean>@MainActor final func analysisHasText(at point: CGPoint) -> BoolReturns a Boolean value that indicates whether the analysis finds text at the specified point. - Parameter point: A point in the image, in view coordinates. - Returns: `true` if text exists at `point`; otherwise, `false`.
hasDataDetector(point: { x: number; y: number }): Promise<boolean>@MainActor final func hasDataDetector(at point: CGPoint) -> BoolReturns a Boolean value that indicates whether the analysis detects data at the specified point. - Parameter point: A point in the image, in view coordinates. - Returns: `true` if the analyzer detects data at `point`; otherwise, `false`.
hasInteractiveItem(point: { x: number; y: number }): Promise<boolean>@MainActor final func hasInteractiveItem(at point: CGPoint) -> BoolReturns a Boolean value that indicates whether active text, data detectors, or supplementary interface objects exist at the specified point. - Parameter point: A point in the image, in view coordinates. - Returns: `true` if active text, data detectors, or supplementary interface objects exist at `point`; otherwise, `false`.
resetTextSelection(): Promise<void>@MainActor final func resetTextSelection()Removes a person’s text selection from the interface.
get highlightedSubjects(): Promise<Array<ImageAnalysisInteraction_Subject>>@MainActor final var highlightedSubjects: Set<ImageAnalysisInteraction.Subject> { get set }All highlighted subjects in the interaction image.
setHighlightedSubjects(value: Array<ImageAnalysisInteraction_Subject>): Promise<void>@MainActor final var highlightedSubjects: Set<ImageAnalysisInteraction.Subject> { get set }All highlighted subjects in the interaction image.
get liveTextButtonVisible(): Promise<boolean>@MainActor final var liveTextButtonVisible: Bool { get }A Boolean value that indicates whether the Live Text button appears. When a person taps the Live Text button, it highlights recognized items in the image.
get hasActiveTextSelection(): Promise<boolean>@MainActor final var hasActiveTextSelection: Bool { get }A Boolean value that indicates whether a person or the app has text selected within the image. If ``VisionKit/ImageAnalysisInteraction/InteractionTypes/textSelection`` is an active interaction type, a person can select text using a standard input method and the app can select text through the ``selectedRanges`` property. If neither a person nor the app select any text, then this property returns `false`.
get selectedAttributedText(): Promise<_Foundation_AttributedString>@MainActor final var selectedAttributedText: AttributedString { get }The current selected attributed text.
hasSupplementaryInterface(point: { x: number; y: number }): Promise<boolean>@MainActor final func hasSupplementaryInterface(at point: CGPoint) -> BoolReturns a Boolean value that indicates whether supplementary interface objects exist at the specified point. Supplementary interface objects include the Live Text button and Quick Actions, depending on the item type. - Parameter point: A point in the image, in view coordinates. - Returns: `true` if supplementary interface objects exist at `point`; otherwise, `false`.
get selectableItemsHighlighted(): Promise<boolean>@MainActor final var selectableItemsHighlighted: Bool { get set }A Boolean value that indicates whether the interaction highlights actionable text or data the analyzer detects in text. The interaction object manages this property value for you. It sets this property to `false` if you set the ``ImageAnalysisInteraction/analysis`` property or the ``ImageAnalysisInteraction/activeInteractionTypes`` property to an empty set. Otherwise, it sets this property depending on whether a person toggles the Live Text button in the interface.
setSelectableItemsHighlighted(value: boolean): Promise<void>@MainActor final var selectableItemsHighlighted: Bool { get set }A Boolean value that indicates whether the interaction highlights actionable text or data the analyzer detects in text. The interaction object manages this property value for you. It sets this property to `false` if you set the ``ImageAnalysisInteraction/analysis`` property or the ``ImageAnalysisInteraction/activeInteractionTypes`` property to an empty set. Otherwise, it sets this property depending on whether a person toggles the Live Text button in the interface.
setContentsRectNeedsUpdate(): Promise<void>@MainActor final func setContentsRectNeedsUpdate()Informs the view that contains the image when the layout changes and the view needs to reload its content. The framework ignores calls to this method when your app adds the interaction to a <doc://com.apple.documentation/documentation/uikit/uiimageview>, which calculates the ``contentsRect`` based on the image view's <doc://com.apple.documentation/documentation/uikit/uiviewcontentmode>. When the view that contains the image isn’t an instance of <doc://com.apple.documentation/documentation/uikit/uiimageview>, call this method when the layout changes. The interaction then invokes the delegate’s ``ImageAnalysisInteractionDelegate/contentsRect(for:)-187x`` callback, which provides the updated content area to the system.
get supplementaryInterfaceFont(): Promise<(_UIKit_UIFont) | null>@MainActor final var supplementaryInterfaceFont: UIFont? { get set }The font to use for the supplementary interface. The interaction also uses the font weight for image symbols, but ignores the point size to keep button sizes consistent.
setSupplementaryInterfaceFont(value?: (_UIKit_UIFont) | null): Promise<void>@MainActor final var supplementaryInterfaceFont: UIFont? { get set }The font to use for the supplementary interface. The interaction also uses the font weight for image symbols, but ignores the point size to keep button sizes consistent.
get isSupplementaryInterfaceHidden(): Promise<boolean>@MainActor final var isSupplementaryInterfaceHidden: Bool { get set }A Boolean value that indicates whether the view hides supplementary interface objects. Supplementary interface objects include the Live Text button and Quick Actions, depending on the item type. Setting this property invokes the ``ImageAnalysisInteraction/setSupplementaryInterfaceHidden(_:animated:)`` method, passing this property value and `true` for the `animated` parameter.
setIsSupplementaryInterfaceHidden(value: boolean): Promise<void>@MainActor final var isSupplementaryInterfaceHidden: Bool { get set }A Boolean value that indicates whether the view hides supplementary interface objects. Supplementary interface objects include the Live Text button and Quick Actions, depending on the item type. Setting this property invokes the ``ImageAnalysisInteraction/setSupplementaryInterfaceHidden(_:animated:)`` method, passing this property value and `true` for the `animated` parameter.
setSupplementaryInterfaceHidden(hidden: boolean, animated: boolean): Promise<void>@MainActor final func setSupplementaryInterfaceHidden(_ hidden: Bool, animated: Bool)Hides or shows supplementary interface objects, such as the Live Action button and Quick Actions, depending on the item type. - Parameter hidden: `true` to hide the supplementary interface; otherwise, `false`. - Parameter animated: `true` to animate the interface transition; otherwise, `false`.
get supplementaryInterfaceContentInsets(): Promise<{ top: number; left: number; bottom: number; right: number }>@MainActor final var supplementaryInterfaceContentInsets: UIEdgeInsets { get set }The distances the edges of content are inset from the supplementary interface.
setSupplementaryInterfaceContentInsets(value: { top: number; left: number; bottom: number; right: number }): Promise<void>@MainActor final var supplementaryInterfaceContentInsets: UIEdgeInsets { get set }The distances the edges of content are inset from the supplementary interface.
get allowLongPressForDataDetectorsInTextMode(): Promise<boolean>@MainActor final var allowLongPressForDataDetectorsInTextMode: Bool { get set }A Boolean value that indicates whether people can press and hold text to activate data detectors. If you set this property to `true` when the interaction type is just text, people can press and hold data in text, even when data detectors aren’t active. Otherwise, people can perform only text actions, such as copy and translate. The default value for this property is `true`.
setAllowLongPressForDataDetectorsInTextMode(value: boolean): Promise<void>@MainActor final var allowLongPressForDataDetectorsInTextMode: Bool { get set }A Boolean value that indicates whether people can press and hold text to activate data detectors. If you set this property to `true` when the interaction type is just text, people can press and hold data in text, even when data detectors aren’t active. Otherwise, people can perform only text actions, such as copy and translate. The default value for this property is `true`.
get text(): Promise<string>@MainActor final var text: String { get }The text contents of the current image analysis.
image(subjects: Array<ImageAnalysisInteraction_Subject>): Promise<_UIKit_UIImage>@MainActor final func image(for subjects: Set<ImageAnalysisInteraction.Subject>) async throws -> UIImageProvides an image asynchronously that contains the given subjects with the background removed. - parameter subjects: An array of subjects to include in the image. If one or more subjects fail to produce an image, the method throws ``VisionKit/ImageAnalysisInteraction/SubjectUnavailable/imageUnavailable``.
hasText(point: { x: number; y: number }): Promise<boolean>@MainActor final func hasText(at point: CGPoint) -> BoolReturns a Boolean value that indicates whether active text exists at the specified point. - Parameter point: A point in the image, in view coordinates. - Returns: `true` if active text exists at `point`; otherwise, `false`.
subject(point: { x: number; y: number }): Promise<(ImageAnalysisInteraction_Subject) | null>@MainActor final func subject(at point: CGPoint) async -> ImageAnalysisInteraction.Subject?Returns the subject at the given point within the interaction's image, if one exists. This method works for interaction types that include ``VisionKit/ImageAnalysisInteraction/InteractionTypes/imageSubject``. The following code retrieves a subject image given a screen point, for instance, where a person taps: ```swift let configuration = ImageAnalyzer.Configuration() ... interaction.preferredInteractionTypes = [.imageSubject] ... let viewPoint = /* A point in view coordinates */ if let subjectObject = try await interaction.subject(at: viewPoint) { if let image = subjectObject.image { // Do something with the subject image. } } ``` - parameter point: A point in view coordinates at which to select a subject. - returns: The subject that resides at `point`; or, `nil`, if no subject resides at `point`.
get analysis(): Promise<(ImageAnalysis) | null>@MainActor final var analysis: ImageAnalysis? { get set }The results of analyzing an image for items that people can interact with.
setAnalysis(value?: (ImageAnalysis) | null): Promise<void>@MainActor final var analysis: ImageAnalysis? { get set }The results of analyzing an image for items that people can interact with.
get delegate(): Promise<(SDKHandle) | null>@MainActor weak final var delegate: (any ImageAnalysisInteractionDelegate)? { get set }The delegate that handles the interaction callbacks.
setDelegate(value?: (SDKHandle) | null): Promise<void>@MainActor weak final var delegate: (any ImageAnalysisInteractionDelegate)? { get set }The delegate that handles the interaction callbacks.
get subjects(): Promise<Array<ImageAnalysisInteraction_Subject>>@MainActor final var subjects: Set<ImageAnalysisInteraction.Subject> { get async }The set of all subjects the framework identifies in an image.
static init35637(delegate: SDKHandle): Promise<ImageAnalysisInteraction>@MainActor convenience init(_ delegate: any ImageAnalysisInteractionDelegate)Creates an interaction for Live Text actions with the specified delegate. - Parameter delegate: The object that provides details about the interface for the interaction.
No declarations were skipped in this snapshot.