-
-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Definitions for Pie component #207
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
59ceae1
Definitions for Pie component
Psvensso 7a5752b
Aligning with bar-package, adding correct class defs., adding dimensi…
Psvensso c91ff67
exporting sub-types
Psvensso fc07742
aligning naming, adding Partial and adding missing enhanced props
21bcb8e
Adding data as optional (external type)
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
declare module '@nivo/pie' { | ||
export class Pie extends React.Component<Data & PieProps & Dimensions>{ } | ||
export class ResponsivePie extends React.Component<Data & PieProps>{ } | ||
|
||
export type LegendItemDirection = | ||
| 'left-to-right' | ||
| 'right-to-left' | ||
| 'top-to-bottom' | ||
| 'bottom-to-top'; | ||
|
||
export type Anchor = | ||
| 'top' | ||
| 'top-right' | ||
| 'right' | ||
| 'bottom-right' | ||
| 'bottom' | ||
| 'bottom-left' | ||
| 'left' | ||
| 'top-left' | ||
| 'center'; | ||
|
||
export type LegendDirection = 'row' | 'column'; | ||
|
||
export type Legend = { | ||
|
||
data: Array<{ label: string | number; fill: string; }>; | ||
|
||
// position & layout | ||
anchor: Anchor; | ||
|
||
translateX: number; // default 0 | ||
translateY: number; // default 0 | ||
direction: LegendDirection; | ||
|
||
// items | ||
itemWidth: number; | ||
itemHeight: number; | ||
itemDirection?: LegendItemDirection; // default left-to-right | ||
itemsSpacing?: number; // default 0 | ||
symbolSize?: number; // default 16 | ||
symbolSpacing?: number; // default 8 | ||
symbolShape?: "circle" | "diamond" | "square" | "triangle", // default square | ||
textColor?: string; // default black | ||
} | ||
|
||
export interface PieDataItem { | ||
id: string; | ||
value: string; | ||
} | ||
|
||
export type SettingsGetterFunc = (dataSlize: PieDataItem) => string; | ||
|
||
export type Data = { data: Array<PieDataItem> }; | ||
|
||
export type PieProps = Partial<{ | ||
sortByValue: boolean; | ||
innerRadius: number; | ||
padAngle: number; | ||
cornerRadius: number; | ||
|
||
// border | ||
borderWidth: number; | ||
borderColor: string | SettingsGetterFunc; | ||
|
||
// radial labels | ||
enableRadialLabels: boolean; | ||
radialLabel: string | SettingsGetterFunc; | ||
radialLabelsSkipAngle: number; | ||
radialLabelsTextXOffset: number; | ||
radialLabelsTextColor: string | SettingsGetterFunc; | ||
radialLabelsLinkOffset: number; | ||
radialLabelsLinkDiagonalLength: number; | ||
radialLabelsLinkHorizontalLength: number; | ||
radialLabelsLinkStrokeWidth: number; | ||
radialLabelsLinkColor: string | SettingsGetterFunc; | ||
|
||
// slices labels | ||
enableSlicesLabels: boolean; | ||
sliceLabel: string | SettingsGetterFunc; | ||
slicesLabelsSkipAngle: number; | ||
slicesLabelsTextColor: string | SettingsGetterFunc; | ||
|
||
|
||
colors: string | string[] | Function; | ||
colorBy: string | Function; | ||
|
||
margin: Box; | ||
|
||
|
||
isInteractive: boolean; | ||
onClick: (dataSlize: PieDataItem, event: React.MouseEvent<SVGPathElement>) => void; | ||
// tooltipFormat?: string | SettingsGetterFunc; No docs, no usage in source | ||
|
||
theme: Theme; | ||
|
||
legends: Array<Legend>; | ||
}>; | ||
|
||
export interface Dimensions { | ||
height: number; | ||
width: number; | ||
} | ||
|
||
export type Theme = Partial<{ | ||
axis: React.CSSProperties; | ||
grid: React.CSSProperties; | ||
markers: React.CSSProperties; | ||
dots: React.CSSProperties; | ||
tooltip: Partial<{ | ||
basic: React.CSSProperties; | ||
container: React.CSSProperties; | ||
table: React.CSSProperties; | ||
tableCell: React.CSSProperties; | ||
}>; | ||
labels: React.CSSProperties; | ||
sankey: Partial<{ label: React.CSSProperties }>; | ||
}> | ||
|
||
export type Box = Partial<{ | ||
bottom: number; | ||
left: number; | ||
right: number; | ||
top: number; | ||
}> | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please review the optional props. in Legend. Is this correct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems ok