auto-hide.d.ts 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. import { IGroup } from '@antv/g-base';
  2. import { AxisLabelAutoHideCfg } from '../../types';
  3. export declare function getDefault(): typeof equidistance;
  4. /**
  5. * 保证首个 label 可见,即使超过 limitLength 也不隐藏
  6. * @param {boolean} isVertical 是否垂直
  7. * @param {IGroup} labelsGroup label 的分组
  8. * @param {number} limitLength 另一个方向的长度限制,autoHide 不关心
  9. * @param {AxisLabelAutoHideCfg} autoHideCfg autoHide overlap 的可选配置参数
  10. */
  11. export declare function reserveFirst(isVertical: boolean, labelsGroup: IGroup, limitLength?: number, autoHideCfg?: AxisLabelAutoHideCfg): boolean;
  12. /**
  13. * 保证最后一个 label 可见,即使超过 limitLength 也不隐藏
  14. * @param {boolean} isVertical 是否垂直
  15. * @param {IGroup} labelsGroup label 的分组
  16. * @param {number} limitLength 另一个方向的长度限制,autoHide 不关心
  17. * @param {AxisLabelAutoHideCfg} autoHideCfg autoHide overlap 的可选配置参数
  18. */
  19. export declare function reserveLast(isVertical: boolean, labelsGroup: IGroup, limitLength?: number, autoHideCfg?: AxisLabelAutoHideCfg): boolean;
  20. /**
  21. * 保证第一个最后一个 label 可见,即使超过 limitLength 也不隐藏
  22. * @param {boolean} isVertical 是否垂直
  23. * @param {IGroup} labelsGroup label 的分组
  24. * @param {number} limitLength 另一个方向的长度限制,autoHide 不关心
  25. * @param {AxisLabelAutoHideCfg} autoHideCfg autoHide overlap 的可选配置参数
  26. */
  27. export declare function reserveBoth(isVertical: boolean, labelsGroup: IGroup, limitLength?: number, autoHideCfg?: AxisLabelAutoHideCfg): boolean;
  28. /**
  29. * 保证 label 均匀显示 和 不出现重叠,主要解决文本层叠的问题,对于 limitLength 不处理
  30. * @param {boolean} isVertical 是否垂直
  31. * @param {IGroup} labelsGroup label 的分组
  32. * @param {number} limitLength 另一个方向的长度限制,autoHide 不关心
  33. * @param {AxisLabelAutoHideCfg} autoHideCfg autoHide overlap 的可选配置参数
  34. */
  35. export declare function equidistance(isVertical: boolean, labelsGroup: IGroup, limitLength?: number, autoHideCfg?: AxisLabelAutoHideCfg): boolean;
  36. /**
  37. * 同 equidistance, 首先会保证 labels 均匀显示,然后会保留首尾
  38. * @param isVertical
  39. * @param labelsGroup
  40. * @param {number} limitLength 另一个方向的长度限制,autoHide 不关心
  41. * @param {AxisLabelAutoHideCfg} autoHideCfg autoHide overlap 的可选配置参数
  42. */
  43. export declare function equidistanceWithReverseBoth(isVertical: boolean, labelsGroup: IGroup, limitLength?: number, autoHideCfg?: AxisLabelAutoHideCfg): boolean;