web / lib/hooks/use-event-stats
lib/hooks/use-event-stats
This file contains custom React hooks for computing statistics from a list of events.
These hooks are designed to efficiently process and aggregate event data for display in
charts and summary components. They use useMemo to ensure that calculations are only
re-run when the underlying event data changes, optimizing performance.
The provided hooks can calculate:
- Overall event statistics (total counts, date ranges, etc.).
- Event counts grouped by dataset or catalog.
Interfaces
EventStats
Properties
totalEvents
totalEvents:
number
eventsWithLocation
eventsWithLocation:
number
eventsWithoutLocation
eventsWithoutLocation:
number
dateRange
dateRange:
object
min
min:
null|Date
max
max:
null|Date
eventsByDataset
eventsByDataset:
Record<string,number>
eventsByCatalog
eventsByCatalog:
Record<string,number>
Functions
useEventStats()
useEventStats(
events):EventStats
Parameters
events
Event[]
Returns
useEventDateAccessor()
useEventDateAccessor(): (
event) =>Date
Returns
(
event):Date
Parameters
event
Event
Returns
Date
useEventsByDataset()
useEventsByDataset(
events,datasets):BarChartDataItem[]
Parameters
events
Event[]
datasets
Dataset[]
Returns
BarChartDataItem[]
useEventsByCatalog()
useEventsByCatalog(
events,catalogs):BarChartDataItem[]
Parameters
events
Event[]
catalogs
Catalog[]
Returns
BarChartDataItem[]