Skip to content

improve: Pass through timeInterval prop to d3-cloud #163

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.

Sign up for GitHub

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

Open
uson1x wants to merge 1 commit into
base: master
Choose a base branch
from
Open

improve: Pass through timeInterval prop to d3-cloud #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ for more detailed props, please refer to below:
| data | The words array | `{ text: string, value: number }>[]` | ✓ |
| width | Width of the layout (px) | `number` | | `700` |
| height | Height of the layout (px) | `number` | | `600` |
| timeInterval | The maximum amount of time that can be spent during the current timestep (ms). Prevents the layout from getting stuck. | `number` | | `Infinity` |
| font | The font accessor function, which indicates the font face for each word. A constant may be specified instead of a function. | `string \| (d) => string` | | `'serif'` |
| fontStyle | The fontStyle accessor function, which indicates the font style for each word. A constant may be specified instead of a function. | `string \| (d) => string` | | `'normal'` |
| fontWeight | The fontWeight accessor function, which indicates the font weight for each word. A constant may be specified instead of a function. | `string \| number \| (d) => string \| number` | | `'normal'` |
Expand Down
6 changes: 6 additions & 0 deletions src/WordCloud.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ type WordCloudProps = {
data: Datum[];
width?: number;
height?: number;
timeInterval?: number;
font?: string | ((word: Word, index: number) => string);
fontStyle?: string | ((word: Word, index: number) => string);
fontWeight?:
Expand All @@ -46,6 +47,7 @@ function WordCloud({
data,
width = 700,
height = 600,
timeInterval,
font = 'serif',
fontStyle = 'normal',
fontWeight = 'normal',
Expand Down Expand Up @@ -130,6 +132,10 @@ function WordCloud({
}
});

if (timeInterval) {
layout.timeInterval(timeInterval);
}

layout.start();

return el.toReact();
Expand Down