API Reference > ui-framework > Picker > ViewSelector

ViewSelector<SS> Class

Beta

View Selector React component

Extends

Methods

Name Description
constructor(props: ViewSelectorProps): ViewSelector Creates a ViewSelector  
componentDidMount(): Promise<void>    
componentWillUnmount(): void    
loadViews(): Promise<void> Query the views and set the initial state with the iModel's views.  
render(): null | Element Renders ViewSelector component  
updateState(viewId?: any): Promise<void> Update state of the entries in the widget.  
updateShowSettings(showSpatials: boolean, showDrawings: boolean, showSheets: boolean, showUnknown: boolean): void Static Updates the ViewSelector show settings.  

Inherited methods

Name Inherited from Description
UNSAFE_componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
UNSAFE_componentWillReceiveProps(nextProps: Readonly<ViewSelectorProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
UNSAFE_componentWillUpdate(nextProps: Readonly<ViewSelectorProps>, nextState: Readonly<ViewSelectorState>, 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<ViewSelectorProps>, prevState: Readonly<ViewSelectorState>, 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<ViewSelectorProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
componentWillUpdate(nextProps: Readonly<ViewSelectorProps>, nextState: Readonly<ViewSelectorState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
forceUpdate(callback?: () => void): void Component  
getSnapshotBeforeUpdate(prevProps: Readonly<ViewSelectorProps>, prevState: Readonly<ViewSelectorState>): 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<ViewSelectorState>, props: Readonly<ViewSelectorProps>) => null | S | object | null | S | object, callback?: () => void): void Component  
shouldComponentUpdate(nextProps: Readonly<ViewSelectorProps>, nextState: Readonly<ViewSelectorState>, nextContext: any): boolean Optional ComponentLifecycle Called to determine whether the change in props and state should trigger a re-render.

Properties

Name Type Description
onViewSelectorChangedEvent Static ViewSelectorChangedEvent Gets the ViewSelectorChangedEvent  

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  
state Readonly<ViewSelectorState> Component  

Object Literals

Name Description
defaultProps Static  

Defined in

Last Updated: 08 January, 2020