word-cloud.d.ts 1.2 KB

123456789101112131415161718192021222324252627282930
  1. import { Tag, Word } from '../../plots/word-cloud/types';
  2. type FontWeight = number | 'normal' | 'bold' | 'bolder' | 'lighter';
  3. export interface Options {
  4. size: [number, number];
  5. font?: string | ((row: Word, index?: number, words?: Word[]) => string);
  6. fontSize?: number | ((row: Word, index?: number, words?: Word[]) => number);
  7. fontWeight?: FontWeight | ((row: Word, index?: number, words?: Word[]) => FontWeight);
  8. rotate?: number | ((row: Word, index?: number, words?: Word[]) => number);
  9. padding?: number | ((row: Word, index?: number, words?: Word[]) => number);
  10. spiral?: 'archimedean' | 'rectangular' | ((size: [number, number]) => (t: number) => number[]);
  11. random?: number | (() => number);
  12. timeInterval?: number;
  13. imageMask?: HTMLImageElement;
  14. }
  15. /**
  16. * 根据对应的数据对象,计算每个
  17. * 词语在画布中的渲染位置,并返回
  18. * 计算后的数据对象
  19. * @param words
  20. * @param options
  21. */
  22. export declare function wordCloud(words: Word[], options?: Partial<Options>): Tag[];
  23. /**
  24. * 抛出没有混入默认配置的方法,用于测试。
  25. * @param words
  26. * @param options
  27. */
  28. export declare function transform(words: Word[], options: Options): any[];
  29. export declare function functor(d: any): any;
  30. export {};