videx-3d/dist/types/hooks/useData.d.ts

React 3D component library designed for sub surface visualizations in the browser

import { Store } from '../sdk/data/Store';
/**
 * Access the store from the `DataProvider` within a component to retrieve data.
 *
 * @example
 * const store = useData()
 *
 * @remarks
 * Use the store in a `useEffect` hook to retrieve the data you need and save it
 * to a local state (if required)
 *
 * @example
 * useEffect(() => {
 *   if (store) {
 *     store.get<WellboreHeader>('wellbore-headers', id).then(response => {
 *       ... // do something with the data
 *     })
 *   }
 * }, [store, id])
 *
 * @see [Data](/videx-3d/docs/documents/data.html)
 *
 * @group Hooks
 */
export declare const useData: () => Store | null;