The ImageEditorView class is a React Component for image editing that wraps the native ImageEditorView. It encapsulates interactions with the native view and provides functionality to set images and edit quadrilaterals.

Hierarchy

Properties

context: unknown

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
refs: { [key: string]: ReactInstance }
state: Readonly<any>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Parameters

    • Optionalcallback: () => void

    Returns void

  • Retrieves the currently selected quadrilateral from the editor.

    Returns Promise<null | Quadrilateral>

    A promise that resolves to the selected quadrilateral, or first Quadrilateral if none is selected.

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

  • Returns ReactNode

  • Sets the original image in the native image editor.

    Parameters

    Returns void

  • Updates the quadrilaterals in the editor for a specific drawing layer.

    Parameters

    • quads: undefined | null | Quadrilateral[]

      The quadrilaterals to set, or null/undefined to clear them. The coordinate base of the point is "image".

    • layerId: number

      The ID of the drawing layer to update.

    Returns Promise<void>

    A promise that resolves once the operation completes.

  • Type Parameters

    • K extends string | number | symbol

    Parameters

    • state: any
    • Optionalcallback: () => void

    Returns void

  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean