-
-
Notifications
You must be signed in to change notification settings - Fork 1k
/
index.d.ts
352 lines (310 loc) · 9.86 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
import * as React from 'react'
import { OpaqueInterpolation, SpringConfig } from 'react-spring'
declare module '@nivo/core' {
export type DatumValue = string | number | Date
export interface Dimensions {
height: number
width: number
}
export type Margin = {
bottom: number
left: number
right: number
top: number
}
export type Box = Partial<Margin>
export type BoxAlign =
| 'center'
| 'top-left'
| 'top'
| 'top-right'
| 'right'
| 'bottom-right'
| 'bottom'
| 'bottom-left'
| 'left'
export const boxAlignments: BoxAlign[]
export function alignBox(box: Box, container: Box, alignment: BoxAlign): [number, number]
export type GetColor<T> = (datum: T) => string
export type Colors = string[] | string
export interface ColorProps<T> {
colors?: Colors
colorBy?: string | GetColor<T>
}
export type CompleteTheme = {
crosshair: {
line: {
stroke: string
strokeWidth: number
strokeOpacity: number
strokeDasharray: string
}
}
background: string
fontFamily: string
fontSize: number
textColor: string
axis: {
domain: {
line: Partial<React.CSSProperties>
}
ticks: {
line: Partial<React.CSSProperties>
text: Partial<React.CSSProperties>
}
legend: {
text: Partial<React.CSSProperties>
}
}
grid: {
line: Partial<React.CSSProperties>
}
legends: {
text: Partial<React.CSSProperties>
}
labels: {
text: Partial<React.CSSProperties>
}
markers: {
lineColor: string
lineStrokeWidth: number
textColor: string
fontSize: string | 0
text: Partial<React.CSSProperties>
}
dots: {
text: Partial<React.CSSProperties>
}
tooltip: {
container: Partial<React.CSSProperties>
basic: Partial<React.CSSProperties>
chip: Partial<React.CSSProperties>
table: Partial<React.CSSProperties>
tableCell: Partial<React.CSSProperties>
}
annotations: {
text: Partial<React.CSSProperties>
link: Partial<React.CSSProperties>
outline: Partial<React.CSSProperties>
symbol: Partial<React.CSSProperties>
}
}
export type Theme = Partial<
Pick<CompleteTheme, 'background' | 'fontFamily' | 'fontSize' | 'textColor'> & {
crosshair: Partial<{
line: Partial<CompleteTheme['crosshair']['line']>
}>
axis: Partial<{
domain: Partial<{
line: Partial<CompleteTheme['axis']['domain']['line']>
}>
ticks: Partial<{
line: Partial<CompleteTheme['axis']['ticks']['line']>
text: Partial<CompleteTheme['axis']['ticks']['text']>
}>
legend: Partial<{
text: Partial<CompleteTheme['axis']['legend']['text']>
}>
}>
grid: Partial<{
line: Partial<CompleteTheme['grid']['line']>
}>
legends: Partial<{
text: Partial<CompleteTheme['legends']['text']>
}>
labels: Partial<{
text: Partial<CompleteTheme['labels']['text']>
}>
markers: Partial<CompleteTheme['markers']>
dots: Partial<{
text: Partial<CompleteTheme['dots']['text']>
}>
tooltip: Partial<CompleteTheme['tooltip']>
annotations: Partial<CompleteTheme['annotations']>
}
>
export function useTheme(): CompleteTheme
export function usePartialTheme(theme?: Theme): CompleteTheme
export type MotionProps = Partial<{
animate: boolean
motionDamping: number
motionStiffness: number
}>
export type ModernMotionProps = Partial<{
animate: boolean
motionConfig: string | SpringConfig
}>
export function useMotionConfig(): {
animate: boolean
config: SpringConfig
springConfig: {
stiffness: number
damping: number
}
}
export type SvgFillMatcher<T> = (datum: T) => boolean
export interface SvgDefsAndFill<T> {
defs?: {
id: string
[key: string]: any
}[]
fill?: { id: string; match: Record<string, unknown> | SvgFillMatcher<T> | '*' }[]
}
export interface CartesianMarkerProps {
axis: 'x' | 'y'
value: string | number | Date
legend?: string
lineStyle?: Partial<React.CSSProperties>
textStyle?: Partial<React.CSSProperties>
}
export type CssMixBlendMode =
| 'normal'
| 'multiply'
| 'screen'
| 'overlay'
| 'darken'
| 'lighten'
| 'color-dodge'
| 'color-burn'
| 'hard-light'
| 'soft-light'
| 'difference'
| 'exclusion'
| 'hue'
| 'saturation'
| 'color'
| 'luminosity'
export type StackOrder = 'ascending' | 'descending' | 'insideOut' | 'none' | 'reverse'
export type StackOffset = 'expand' | 'diverging' | 'none' | 'silhouette' | 'wiggle'
export type AreaCurve =
| 'basis'
| 'cardinal'
| 'catmullRom'
| 'linear'
| 'monotoneX'
| 'monotoneY'
| 'natural'
| 'step'
| 'stepAfter'
| 'stepBefore'
export function useAnimatedPath(path: string): OpaqueInterpolation<string>
export type LinearGradientDef = {
id: string
type: 'linearGradient'
colors: {
offset: number
color: string
opacity?: number
}[]
}
export type PatternDotsDef = {
id: string
type: 'patternDots'
color?: string
background?: string
size?: number
padding?: number
stagger?: boolean
}
export type PatternSquaresDef = Omit<PatternDotsDef, 'type'> & {
type: 'patternSquares'
}
export type PatternLinesDef = {
id: string
type: 'patternLines'
spacing?: number
rotation?: number
background?: string
color?: string
lineWidth?: number
}
export type Def = LinearGradientDef | PatternDotsDef | PatternSquaresDef | PatternLinesDef
export type DefsProps = {
defs: Def[]
}
export declare const defaultAnimate = true
export declare const defaultMotionStiffness = 90
export declare const defaultMotionDamping = 15
export declare const motionDefaultProps = {
animate: true,
stiffness: 90,
damping: 15,
config: 'default',
}
export declare const defaultMargin = {
top: 0,
right: 0,
bottom: 0,
left: 0,
}
export function PatternLines(props: Omit<PatternLinesDef, 'type'>): JSX.Element
export function PatternSquares(props: Omit<PatternSquaresDef, 'type'>): JSX.Element
export function PatternDots(props: Omit<PatternDotsDef, 'type'>): JSX.Element
export function Defs(props: DefsProps): JSX.Element
export function degreesToRadians(degrees: number): number
export function radiansToDegrees(radians: number): number
type Accessor<T, U> = T extends string ? U[T] : never
export type DatumPropertyAccessor<RawDatum, T> = (datum: RawDatum) => T
export function useDimensions(
width: number,
height: number,
margin?: Box
): {
margin: Margin
innerWidth: number
innerHeight: number
outerWidth: number
outerHeight: number
}
export const SvgWrapper = (
props: React.PropsWithChildren<{
width: number
height: number
margin: Margin
defs?: any
role?: string
}>
) => JSX.Element
interface ContainerProps {
theme?: Theme
renderWrapper?: boolean
isInteractive?: boolean
animate?: boolean
motionStiffness?: number
motionDamping?: number
motionConfig?: string | SpringConfig
}
export const Container = (props: React.PropsWithChildren<ContainerProps>) => JSX.Element
export const ResponsiveWrapper = (props: {
children: (dimensions: { width: number; height: number }) => JSX.Element
}) => JSX.Element
export function getDistance(x1: number, y1: number, x2: number, y2: number): number
export function getAngle(x1: number, y1: number, x2: number, y2: number): number
export function radiansToDegrees(radians: number): number
export function degreesToRadians(degrees: number): number
export function positionFromAngle(
angle: number,
distance: number
): {
x: number
y: number
}
export type ValueFormat<Value> =
// d3 formatter
| string
// explicit formatting function
| ((value: Value) => string)
export function getValueFormatter<Value>(format?: ValueFormat<Value>): (value: Value) => string
export function useValueFormatter<Value>(format?: ValueFormat<Value>): (value: Value) => string
export type PropertyAccessor<Datum, Value> =
// path to use with `lodash.get()`
| string
// explicit accessor function
| ((datum: Datum) => Value)
export function getPropertyAccessor<Datum, Value>(
accessor: PropertyAccessor<Datum, Value>
): (datum: Datum) => Value
export function usePropertyAccessor<Datum, Value>(
accessor: PropertyAccessor<Datum, Value>
): (datum: Datum) => Value
}