Interface DrawingAreaProps

interface DrawingAreaProps {
    disableDrag?: boolean;
    disableResize?: boolean;
    disabled?: boolean;
    drawingContainer: IDrawingContainer<any>;
    drawingContainerView: IDrawingContainerView<any>;
    onFirstRender?: (() => void);
    onUnFocus?: (() => void);
    renderDirections?: string[];
    renderDrawing: ((props) => ReactElement<any, string | JSXElementConstructor<any>>);
    transactionStack: ITransactionStack;
    view: GridOverlayView;
}

Hierarchy

  • HTMLAttributes<HTMLDivElement>
    • DrawingAreaProps

Properties

disableDrag? disableResize? disabled? drawingContainer drawingContainerView onFirstRender? onUnFocus? renderDirections? renderDrawing transactionStack view

Properties

Optional disableDrag

disableDrag?: boolean

If disabled then unable to move.

Default Value

false

Optional disableResize

disableResize?: boolean

If disabled then unable to resize.

Default Value

false

Optional disabled

disabled?: boolean

If disabled then drawing selection will not be allowed and frames will be passed disabled.

Default Value

false

drawingContainer

drawingContainer: IDrawingContainer<any>

The container to retrieve drawing objects

drawingContainerView

drawingContainerView: IDrawingContainerView<any>

The container view to retrieve selection information about the drawings.

Optional onFirstRender

onFirstRender?: (() => void)

Called after the first render of a drawing.

Type declaration

    • (): void

    • Returns void

Returns

Optional onUnFocus

onUnFocus?: (() => void)

Called when the final drawing is unselected.

Type declaration

    • (): void

    • Returns void

Optional renderDirections

renderDirections?: string[]

Provider the anchor element to render.

renderDrawing

renderDrawing: ((props) => ReactElement<any, string | JSXElementConstructor<any>>)

Callback to render the Drawing

Type declaration

    • (props): ReactElement<any, string | JSXElementConstructor<any>>

    • Parameters

      Returns ReactElement<any, string | JSXElementConstructor<any>>

Returns

transactionStack

transactionStack: ITransactionStack

If provided this will be used start and stop transactions on being/end move.

view

view: GridOverlayView

The gridView

Settings

Member Visibility

Theme

On This Page

disableDragdisableResizedisableddrawingContainerdrawingContainerViewonFirstRenderonUnFocusrenderDirectionsrenderDrawingtransactionStackview