Skip to main content

Hooks

useActivePivotClient#

React hook returning the ActivePivotClient at serverKey.

useActivePivotClient(serverKey)
ArgumentTypeDescription
serverKeystring | undefined
Returns:

ActivePivotClient | undefined

Throws:

ClientsNotFoundError when no clients are provided via ClientsProvider.

ActivePivotClientNotFoundError when serverKey is defined but no ActivePivotClient is provided for this key via ClientsProvider.

useActivePivotClients#

React hook returning the map of all registered ActivePivotClients.

useActivePivotClients()
Returns:

{ [serverKey: string]: ActivePivotClient; }

useActivity#

React hook returning the value for the given activity key, along with a function to update this value.

useActivity(key)
ArgumentTypeDescription
keyT
Returns:

[Activity[T] | null, (value: Activity[T]) => void]

useConnectionStatuses#

React hook returning the overall status of the connection with the registered ActivePivot clients.

useConnectionStatuses()
Returns:

{ [serverKey: string]: ConnectionStatus; }

useContentClient#

React hook returning the ContentClient.

useContentClient()
Returns:

ContentClient

Throws:

ClientsNotFoundError when no clients are provided via ClientsProvider.

ContentClientNotFoundError when no ContentClient is provided via ClientsProvider.

useDataModel#

React hook returning the DataModel of the ActivePivot server identified by serverKey.

useDataModel(serverKey)
ArgumentTypeDescription
serverKeystring | undefined
Returns:

DataModel | undefined

Throws:

DataModelNotFoundError when serverKey is defined but the data model could not be found.

useDataModels#

React hook returning the data models of all ActivePivot servers to which the client is connected.

useDataModels()
Returns:

{ [serverKey: string]: DataModel; }

useIsModalMounted#

Hook returning whether a modal should be mounted/unmounted depending on whether it is visible. It allows to reset the state of a Modal declaratively, without losing Ant Design's close animation.

See https://github.com/activeviam/activeui-5/pull/1465\#issuecomment-862306468.

useIsModalMounted(isModalVisible)
ArgumentTypeDescription
isModalVisibleboolean
Returns:

boolean

For example:
const ModalParent = () => {  const [isModalVisible, setIsModalVisible] = useState(false);  const isModalMounted = useIsModalMounted(isModalVisible);  const handleModalClosed = () => {setIsModalVisible(false);};  return isModalMounted &&     <Modal         isVisible={isModalVisible}         onSubmit={handleModalClosed}         onCancel={handleModalClosed}      >         <ModalChildren />     </Modal>}

useIsPresenting#

React hook returning the current state of isPresenting.

useIsPresenting()
Returns:

boolean

usePersisted#

React hook returning the value for the key in the browser local storage and the function to update it.

usePersisted(key, initialValue)
ArgumentTypeDescription
keystring
initialValueT
Returns:

[T | undefined, (newValue: T) => void]

useQuery#

React hook returning the up-to-date Query corresponding to queryId.

useQuery({   serverKey,   queryId, })
ArgumentTypeDescription
{
   serverKey,
   queryId,
}
{
   serverKey?: string;
   queryId?: string;
}
Returns:

Query<MdxString> | undefined

useQueryResult#

Subscribes to a query's result. If queryId is not provided, returns an empty result. If queryId is provided: returns an up-to-date result. If queryId and query are provided and a query already exists for this serverKey and queryId: updates that query. Otherwise, registers query within serverKey.

useQueryResult({   serverKey,   queryId,   query, })
ArgumentTypeDescription
{
   serverKey,
   queryId,
   query,
}
{
   serverKey?: string;
   queryId?: string;
   query?: Query<MdxString>;
}
Returns:

QueryResult<ResultType>

useSetting#

React hook returning the setting value for the given key, along with a function to update this value.

useSetting(key)
ArgumentTypeDescription
keyT
Returns:

[Settings[T], (value: Settings[T]) => void]

useSwitchedWidgetState#

React Hook returning the switched widget state if switched or the original state if not switched.

useSwitchedWidgetState(widgetState, queryId)
ArgumentTypeDescription
widgetStateWidgetState
queryIdstring
Returns:

WidgetState

useTheme#

React hook returning the Theme.

useTheme()
Returns:

Theme

useTree#

React hook returning the dashboards or widgets tree.

useTree(type)
ArgumentTypeDescription
typeT
Returns:

ContentRecord<DashboardMetaData | WidgetMetaData | FilterMetaData> | null

useUser#

React hook returning the user from context.

useUser()
Returns:

User

Throws:

UserNotFoundError when no User is provided via UserProvider.

useUserGroupNames#

React hook returning the user group names from context.

useUserGroupNames()
Returns:

UserGroupName[] | null

useUserNames#

React hook returning the provided user names from context.

useUserNames()
Returns:

UserName[] | null

useWidgetName#

React Hook returning either widgetState.name if defined otherwise returns a translated initial name from the widget plugin.

useWidgetName(widgetState)
ArgumentTypeDescription
widgetStateAWidgetState
Returns:

string

useWidgetPluginKeys#

React hook returning the keys of all the registered widget plugins.

useWidgetPluginKeys()
Returns:

string[]

useWidgetPlugins#

React hook returning the widget plugins corresponding to widgetKeys.

useWidgetPlugins(widgetKeys)
ArgumentTypeDescription
widgetKeysstring[]
Returns:

WidgetPlugin[]

useWidgetQuery#

Returns the widget's Query, impacted by the page and dashboard filters and the query contexts found in dashboardState and paused when the widget is in an inactive dashboard page.

useWidgetQuery({   widgetState,   dashboardState,   pageKey,   cube,   ranges, })
ArgumentTypeDescription
{
   widgetState,
   dashboardState,
   pageKey,
   cube,
   ranges,
}
{
   widgetState: WidgetWithQueryState<MdxSelect | MdxDrillthrough>;
   dashboardState: DashboardState | undefined;
   pageKey?: string;
   cube: Cube;
   ranges?: Partial<{
     [axisId in AxisId]: QueryRange;
  }>;
}
Returns:

Query<MdxString> | undefined