API Reference > ui-framework > Notification > PointerMessage

PointerMessage<SS> Class

Pointer message pops up near pointer when attempting an invalid interaction.

Extends

Methods

Name Description
constructor(props: Readonly<PointerMessageProps>): PointerMessage   Deprecated
constructor(props: PointerMessageProps, context?: any): PointerMessage   Deprecated
componentDidMount(): void    
componentWillUnmount(): void    
render(): React.ReactNode    
hideMessage(): void Static    
showMessage(message: NotifyMessageDetails): void Static    
updateMessage(displayPoint: XAndY, relativePosition: RelativePosition): void Static    

Inherited methods

Name Inherited from Description
UNSAFE_componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
UNSAFE_componentWillReceiveProps(nextProps: Readonly<PointerMessageProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
UNSAFE_componentWillUpdate(nextProps: Readonly<PointerMessageProps>, nextState: Readonly<PointerMessageState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
componentDidCatch(error: Error, errorInfo: ErrorInfo): void Optional ComponentLifecycle Catches exceptions generated in descendant components.
componentDidUpdate(prevProps: Readonly<PointerMessageProps>, prevState: Readonly<PointerMessageState>, snapshot?: SS): void Optional NewLifecycle Called immediately after updating occurs.
componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
componentWillReceiveProps(nextProps: Readonly<PointerMessageProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
componentWillUpdate(nextProps: Readonly<PointerMessageProps>, nextState: Readonly<PointerMessageState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
forceUpdate(callback?: () => void): void Component  
getSnapshotBeforeUpdate(prevProps: Readonly<PointerMessageProps>, prevState: Readonly<PointerMessageState>): SS | null Optional NewLifecycle Runs before React applies the result of render to the document, and
returns an object to be given to componentDidUpdate.
setState<K extends undefined>(state: (prevState: Readonly<PointerMessageState>, props: Readonly<PointerMessageProps>) => null | S | object | null | S | object, callback?: () => void): void Component  
shouldComponentUpdate(nextProps: Readonly<PointerMessageProps>, nextState: Readonly<PointerMessageState>, nextContext: any): boolean Optional ComponentLifecycle Called to determine whether the change in props and state should trigger a re-render.

Properties

Name Type Description
onPointerMessageChangedEvent Accessor StaticReadOnly PointerMessageChangedEvent    

Inherited properties

Name Type Inherited from Description
context any Component If using the new style context, re-declare this in your class to be the
React.ContextType of your static contextType.
contextType Static undefined | Context<any> Component If set, this.context will be set at runtime to the current value of the given Context.
props undefined Component  
refs [key: string]: ReactInstance Component  

Object Literals

Name Description
state  

Defined in

Last Updated: 08 January, 2020