Class IgrPropertyEditorPropertyDescription<P>

Type Parameters

Hierarchy

Hierarchy

  • Component<P, {}>
    • IgrPropertyEditorPropertyDescription

Constructors

Properties

context: any

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>
props: Readonly<P> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
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}</>;
}
}

Accessors

  • get coercedPrimitiveValue(): any
  • Returns any

  • set coercedPrimitiveValue(v): void
  • Parameters

    • v: any

    Returns void

  • Returns string[]

  • Parameters

    • v: string[]

    Returns void

  • Returns string[]

  • Parameters

    • v: string[]

    Returns void

  • get editorWidth(): number
  • Returns number

  • set editorWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get elementDescriptionType(): string
  • Returns string

  • set elementDescriptionType(v): void
  • Parameters

    • v: string

    Returns void

  • get label(): string
  • Returns string

  • set label(v): void
  • Parameters

    • v: string

    Returns void

  • get labelWidth(): number
  • Returns number

  • set labelWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get max(): number
  • Returns number

  • set max(v): void
  • Parameters

    • v: number

    Returns void

  • get min(): number
  • Returns number

  • set min(v): void
  • Parameters

    • v: number

    Returns void

  • get name(): string
  • Gets or sets the unique name of the mapping.

    Returns string

  • set name(v): void
  • Parameters

    • v: string

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get primitiveValue(): any
  • Returns any

  • set primitiveValue(v): void
  • Parameters

    • v: any

    Returns void

  • get propertyDescriptionType(): string
  • Returns string

  • set propertyDescriptionType(v): void
  • Parameters

    • v: string

    Returns void

  • get propertyPath(): string
  • Returns string

  • set propertyPath(v): void
  • Parameters

    • v: string

    Returns void

  • get shouldOverrideDefaultEditor(): boolean
  • Returns boolean

  • set shouldOverrideDefaultEditor(v): void
  • Parameters

    • v: boolean

    Returns void

  • get step(): number
  • Returns number

  • set step(v): void
  • Parameters

    • v: number

    Returns void

  • get subtitle(): string
  • Returns string

  • set subtitle(v): void
  • Parameters

    • v: string

    Returns void

  • get useCoercedValue(): boolean
  • Returns boolean

  • set useCoercedValue(v): void
  • Parameters

    • v: boolean

    Returns void

Methods

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

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • 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

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    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

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • 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<P>
    • prevState: Readonly<{}>

    Returns any

  • Returns any

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean