Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DrawingMenu<S, SS, S>

Type parameters

  • S

  • SS

  • S

Hierarchy

  • Component<Props>
    • DrawingMenu

Index

Constructors

constructor

Properties

acceptEdit

acceptEdit: function

Type declaration

    • (): void
    • Returns void

cancelClick

cancelClick: function

Type declaration

    • (): void
    • Returns void

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

controlsMap

controlsMap: DrawingControlMap

drawingContext

drawingContext: DrawingContext

props

props: Readonly<Props> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

setShape

setShape: function

Type declaration

    • Parameters

      Returns void

state

state: Readonly<S>

Static Optional contextType

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}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<Props>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<Props>, nextState: Readonly<S>, nextContext: any): void

cancelShapeDrawing

  • cancelShapeDrawing(): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUpdate

  • componentDidUpdate(prevProps: Props): void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<Props>, nextContext: any): void

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<Props>, nextState: Readonly<S>, nextContext: any): void

drawShape

  • drawShape(): void

forceUpdate

  • forceUpdate(callback?: undefined | function): void
  • Parameters

    • Optional callback: undefined | function

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<Props>, prevState: Readonly<S>): SS | null
  • 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

    • prevProps: Readonly<Props>
    • prevState: Readonly<S>

    Returns SS | null

isDrawing

  • isDrawing(): boolean

render

  • render(): Element

renderShapeButton

  • renderShapeButton(shape: Shape, icon: any): null | Element

setDrawingActive

  • setDrawingActive(active: boolean): void

setState

  • setState<K>(state: function | null | S | object, callback?: undefined | function): void
  • Type parameters

    • K: keyof S

    Parameters

    • state: function | null | S | object
    • Optional callback: undefined | function

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<Props>, nextState: Readonly<S>, nextContext: any): boolean
  • 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

    • nextProps: Readonly<Props>
    • nextState: Readonly<S>
    • nextContext: any

    Returns boolean

Generated using TypeDoc