Page Navigator · 分页器

1 min read

分页器用于将一页画布拆分成多页

引入

import { PageNavigator } from '@antv/gui';

配置项

属性描述类型默认值
view待分页对象DisplayObject
width画布宽度(若不指定,则自动进行测算)number
height画布宽度number
pageWidth页宽number
pageHeight页高number
effect翻页动画效果string
duration翻页耗时'horizontal' | 'vertical'horizontal
orientation默认分页方向number
initPageNum初始化页码number
pageLimit总页数限制,默认可根据画布宽高、页宽高与分页方向推断。指定回调方法时,需要手动配置该项number
loop循环翻页booleanfalse
pageCallback自定义页位置回调方法(pageNum: number)=>{x: number, y: number}
button按钮{prev:ButtonCfg, next:ButtonCfg, spacing: number, position: 'top' | 'bottom' | 'left' | 'right'|'horizontal'|'vertical'}
pagination页码false | {type:'', style: MixAttrs, separator:string,spacing: number, position: 'top' | 'bottom' | 'left' | 'right'}

API

方法说明参数
goTo(to: number, from: number)从某页跳转到另一页to: 目标页,from: 起始页(默认为当前页)
prev()向前翻页
next()向后翻页