Interface DrawingElementProps

interface DrawingElementProps {
    disabled?: boolean;
    drawing: IDrawingModel<DrawingJSON>;
    isDragging?: boolean;
    onHide: ((hide) => void);
    onShow: ((show) => void);
    view: GridOverlayView;
}

Hierarchy (view full)

Properties

disabled? drawing isDragging? onHide onShow view

Properties

Optional disabled

disabled?: boolean

If true then the component is disabled.

Default Value

false

Remarks

To see if an element is readonly check the IDrawingModel.isProtected() method.

drawing

drawing: IDrawingModel<DrawingJSON>

The underlying model for the drawing.

Optional isDragging

isDragging?: boolean

Indicator for dragging.

Default Value

false

onHide

onHide: ((hide) => void)

Called when the drawing is hidden from view. If this returns a false the drawing will not be unmounted but will still have a style opacity property of 0 (and pointerEvents of none).

Type declaration

    • (hide): void

    • Parameters

      • hide: ((drawing) => boolean | void | Promise<boolean>)
          • (drawing): boolean | void | Promise<boolean>

          • Parameters

            Returns boolean | void | Promise<boolean>

      Returns void

Remarks

Keeping a drawing mounted is useful for elements that take a long of time to render but increase the memory footprint of the application.

onShow

onShow: ((show) => void)

Call when the drawing is returned to the view.

Type declaration

    • (show): void

    • Parameters

      Returns void

view

view: GridOverlayView

The view to use for the drawing. // TODO - this should not be the GridOverlayView, rather a simpler interface that doesn't have a grid dependency.

Settings

Member Visibility

Theme

On This Page

disableddrawingisDraggingonHideonShowview