Skip to content
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 5 commits into from
May 29, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 125 additions & 0 deletions packages/nivo-pie/index.d.ts
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 = {

Copy link
Contributor Author

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?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems ok

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;
}>
}