UNPKG

opendash

Version:

open.DASH data visualization framework

17 lines (16 loc) • 711 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import { DataItemInterface } from ".."; declare type DataItemValueDimension = number; declare type useWidgetDataItemResult = [DataItemInterface, DataItemValueDimension, (item: [string, DataItemValueDimension]) => void]; /** * Use this hook to get the currently selected data item for the widget. * It may come from two places: * * 1. If your widget requests the selection of an data item * it may be the one selected by the user. * 2. If your widget is placed on a linked dashboard, the linked * data item may be returned. * * If your widget fits none of the above, the hook will throw an Error */ export declare function useWidgetDataItem(): useWidgetDataItemResult; export {};