@cognite/3d-wrapper-react > Viewer
React Component that displays cognite 3d models using the cognite 3d-viewer export:
class: Viewer
extends: {React.Component}
Component<ViewerProps>
↳ Viewer
⊕ new Viewer(props: ViewerProps): Viewer
Overrides Component.__constructor
Defined in viewer.tsx:132
Creates an instance of Viewer. memberof: Viewer
Parameters:
| Name | Type | Description |
|---|---|---|
| props | ViewerProps | - |
Returns: Viewer
● context: any
Inherited from Component.context
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:392
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
● props: * Readonly<object> & Readonly<ViewerProps>
*
Inherited from Component.props
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:417
● refs: object
Inherited from Component.refs
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:423
deprecated: https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs
● state: Readonly<S>
Inherited from Component.state
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:418
<Static><Optional> contextType● contextType: Context<any>
Inherited from Component.contextType
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:377
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
<Optional> UNSAFE_componentWillMount▸ UNSAFE_componentWillMount(): void
Inherited from DeprecatedLifecycle.UNSAFE_componentWillMount
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:605
Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated: 16.3, use componentDidMount or the constructor instead
see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Returns: void
<Optional> UNSAFE_componentWillReceiveProps▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly<ViewerProps>, nextContext: any): void
Inherited from DeprecatedLifecycle.UNSAFE_componentWillReceiveProps
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:637
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.
Calling Component#setState generally does not trigger this method.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated: 16.3, use static getDerivedStateFromProps instead
see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters:
| Name | Type |
|---|---|
| nextProps | Readonly<ViewerProps> |
| nextContext | any |
Returns: void
<Optional> UNSAFE_componentWillUpdate▸ UNSAFE_componentWillUpdate(nextProps: Readonly<ViewerProps>, nextState: Readonly<S>, nextContext: any): void
Inherited from DeprecatedLifecycle.UNSAFE_componentWillUpdate
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:665
Called immediately before rendering when new props or state is received. Not called for the initial render.
Note: You cannot call Component#setState here.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated: 16.3, use getSnapshotBeforeUpdate instead
see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters:
| Name | Type |
|---|---|
| nextProps | Readonly<ViewerProps> |
| nextState | Readonly<S> |
| nextContext | any |
Returns: void
<Optional> componentDidCatch▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void
Inherited from ComponentLifecycle.componentDidCatch
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:534
Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
Parameters:
| Name | Type |
|---|---|
| error | Error |
| errorInfo | ErrorInfo |
Returns: void
▸ componentDidMount(): void
Overrides ComponentLifecycle.componentDidMount
Defined in viewer.tsx:185
Returns: void
▸ componentDidUpdate(prevProps: ViewerProps): void
Overrides NewLifecycle.componentDidUpdate
Defined in viewer.tsx:214
Parameters:
| Name | Type |
|---|---|
| prevProps | ViewerProps |
Returns: void
<Optional> componentWillMount▸ componentWillMount(): void
Inherited from DeprecatedLifecycle.componentWillMount
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:591
Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated: 16.3, use componentDidMount or the constructor instead; will stop working in React 17
see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Returns: void
<Optional> componentWillReceiveProps▸ componentWillReceiveProps(nextProps: Readonly<ViewerProps>, nextContext: any): void
Inherited from DeprecatedLifecycle.componentWillReceiveProps
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:620
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.
Calling Component#setState generally does not trigger this method.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated: 16.3, use static getDerivedStateFromProps instead; will stop working in React 17
see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters:
| Name | Type |
|---|---|
| nextProps | Readonly<ViewerProps> |
| nextContext | any |
Returns: void
<Optional> componentWillUnmount▸ componentWillUnmount(): void
Inherited from ComponentLifecycle.componentWillUnmount
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:529
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
<Optional> componentWillUpdate▸ componentWillUpdate(nextProps: Readonly<ViewerProps>, nextState: Readonly<S>, nextContext: any): void
Inherited from DeprecatedLifecycle.componentWillUpdate
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:650
Called immediately before rendering when new props or state is received. Not called for the initial render.
Note: You cannot call Component#setState here.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated: 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17
see: https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters:
| Name | Type |
|---|---|
| nextProps | Readonly<ViewerProps> |
| nextState | Readonly<S> |
| nextContext | any |
Returns: void
▸ forceUpdate(callBack?: * undefined | function*): void
Inherited from Component.forceUpdate
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:409
Parameters:
| Name | Type |
|---|---|
Optional callBack |
undefined | function |
Returns: void
▸ getScreenshot(width?: * undefined | number, height?: * undefined | number): Promise<string>
Defined in viewer.tsx:169
Takes a screenshot of the model as seen by the viewer. memberof: Viewer
Parameters:
| Name | Type |
|---|---|
Optional width |
undefined | number |
Optional height |
undefined | number |
Returns: Promise<string>
<Optional> getSnapshotBeforeUpdate▸ getSnapshotBeforeUpdate(prevProps: Readonly<ViewerProps>, prevState: Readonly<S>): SS | null
Inherited from NewLifecycle.getSnapshotBeforeUpdate
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:570
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:
| Name | Type |
|---|---|
| prevProps | Readonly<ViewerProps> |
| prevState | Readonly<S> |
Returns: SS | null
▸ render(): Element
Overrides Component.render
Defined in viewer.tsx:279
Returns: Element
▸ setState<K>(state: * function | null | S | object, callback?: * undefined | function): void
Inherited from Component.setState
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:404
Type parameters:
keyof SParameters:
| Name | Type |
|---|---|
| state | function | null | S | object |
Optional callback |
undefined | function |
Returns: void
<Optional> shouldComponentUpdate▸ shouldComponentUpdate(nextProps: Readonly<ViewerProps>, nextState: Readonly<S>, nextContext: any): boolean
Inherited from ComponentLifecycle.shouldComponentUpdate
Defined in /Users/chadbissett/Documents/3d-wrapper/packages/3d-wrapper-react/node_modules/@types/react/index.d.ts:524
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:
| Name | Type |
|---|---|
| nextProps | Readonly<ViewerProps> |
| nextState | Readonly<S> |
| nextContext | any |
Returns: boolean