Developer Docs
API Reference
React Hooks
Use Events Queries
Variables
Variable: eventsQueryKeys

web


web / lib/hooks/use-events-queries / eventsQueryKeys

Variable: eventsQueryKeys

const eventsQueryKeys: object

Type declaration

all

all: readonly ["events"]

lists()

lists: () => readonly ["events", "list"]

Returns

readonly ["events", "list"]

list()

list: (filters, bounds, limit) => readonly ["events", "list", { filters: FilterState; bounds: BoundsType; limit: number; }]

Parameters

filters

FilterState

bounds

BoundsType

limit

number

Returns

readonly ["events", "list", { filters: FilterState; bounds: BoundsType; limit: number; }]

clusters()

clusters: () => readonly ["events", "clusters"]

Returns

readonly ["events", "clusters"]

cluster()

cluster: (filters, bounds, zoom) => readonly ["events", "clusters", { filters: FilterState; bounds: BoundsType; zoom: number; }]

Parameters

filters

FilterState

bounds

BoundsType

zoom

number

Returns

readonly ["events", "clusters", { filters: FilterState; bounds: BoundsType; zoom: number; }]

histograms()

histograms: () => readonly ["events", "histogram"]

Returns

readonly ["events", "histogram"]

histogram()

histogram: (filters, bounds) => readonly ["events", "histogram", { filters: FilterState; bounds: BoundsType; }]

Parameters

filters

FilterState

bounds

BoundsType

Returns

readonly ["events", "histogram", { filters: FilterState; bounds: BoundsType; }]

imports()

imports: () => readonly ["imports"]

Returns

readonly ["imports"]

importProgress()

importProgress: (importId) => readonly ["imports", "progress", string]

Parameters

importId

string

Returns

readonly ["imports", "progress", string]