TocManager

xuld

2020/11/9(#1, xuld)

API

查看源码
(共 153 行)`TOCManager 类`

表示一个目录管理器

构造函数

`TOCManager`查看源码
(共 9 行)`new TOCManager`

初始化新的目录管理器

参数

参数名说明类型

参数名	说明	类型
(可选)`counter`	生成计数器的回调函数默认值：(counts, item) => item.level === 0 ? `${counts[counts.length - 1]}. ` : item.level === 1 ? `${counts[counts.length - 2]}.${counts[counts.length - 1]} ` : undefined;	`(counts: number[], item: TOCItem) => string`
(可选)`counterStart`	开始计数的索引默认值：`2;`	`number`

(可选)counter

生成计数器的回调函数

默认值：(counts, item) => item.level === 0 ? `${counts[counts.length - 1]}. ` : item.level === 1 ? `${counts[counts.length - 2]}.${counts[counts.length - 1]} ` : undefined;

(counts: number[], item: TOCItem) => string

(可选)counterStart

开始计数的索引

默认值：2;

number

属性

属性名	说明	类型
`counterStart`只读	开始计数的索引	`number`
`items`只读	获取所有顶级目录项展开子属性 `level`: `number` — 当前目录项的缩进等级 `label`: `string` — 当前目录项的文案 `anchor`: `string` — 当前目录项的描点 `counter`: `string` — 当前目录项的计数器 `items`: `array` — 子级目录项 `level`: `number` — 当前目录项的缩进等级 `label`: `string` — 当前目录项的文案 `anchor`: `string` — 当前目录项的描点 `counter`: `string` — 当前目录项的计数器 `items`: `(Circular)TOCItem[]` — 子级目录项	`TOCItem[]`
`counter`(可选)只读	生成计数器的回调函数	`(counts: number[], item: TOCItem) => string`

方法

`TOCManager`查看源码
(共 55 行)`add`

添加一个目录项

参数

参数名	说明	类型
`label`	目录的内容	`string`
`level`	目录的等级	`number`
(可选)`anchor`	自定义描点	`string`
(可选)`counter`	自定义计数器	`string`

返回值

类型：TOCItem

`TOCManager`查看源码
(共 16 行)`addAnchor`

添加一个新描点

参数

参数名	说明	类型
`label`	原始文案	`string`

返回值

类型：string

`TOCManager`查看源码
(共 18 行)`findItem`

查找满足条件的第一个索引项，如果找不到返回 undefined

参数

参数名说明类型

参数名	说明	类型
`callback`	判断是否满足条件的回调函数	`(item: TOCItem, parent: TOCItem \| TOCManager) => boolean`
(可选)`parent`	如果指定的根节点从只从指定节点范围查找展开子属性 `level`: `number` — 当前目录项的缩进等级 `label`: `string` — 当前目录项的文案 `anchor`: `string` — 当前目录项的描点 `counter`: `string` — 当前目录项的计数器 `items`: `array` — 子级目录项 `level`: `number` — 当前目录项的缩进等级 `label`: `string` — 当前目录项的文案 `anchor`: `string` — 当前目录项的描点 `counter`: `string` — 当前目录项的计数器 `items`: `(Circular)TOCItem[]` — 子级目录项默认值：`this;`	`TOCItem \| TOCManager`

callback

判断是否满足条件的回调函数

(item: TOCItem, parent: TOCItem | TOCManager) => boolean

(可选)parent

如果指定的根节点从只从指定节点范围查找

展开子属性

level: number — 当前目录项的缩进等级
label: string — 当前目录项的文案
anchor: string — 当前目录项的描点
counter: string — 当前目录项的计数器
items: array — 子级目录项
- level: number — 当前目录项的缩进等级
- label: string — 当前目录项的文案
- anchor: string — 当前目录项的描点
- counter: string — 当前目录项的计数器
- items: (Circular)TOCItem[] — 子级目录项

默认值：this;

TOCItem | TOCManager

返回值

类型：TOCItem

`TOCManager`查看源码
(共 7 行)`findAnchor`

查找指定内容的描点

参数

参数名	说明	类型
`label`	目录的内容	`string`

返回值

类型：string

`TOCManager`查看源码
(共 7 行)`findLabel`

获取指定描点的文本内容

参数

参数名	说明	类型
`anchor`	描点	`string`

返回值

类型：string

`TOCManager`查看源码
(共 7 行)`toAnchor`

获取指定文案的描点

参数

参数名	说明	类型
`label`	文案	`string`

返回值

类型：string

查看源码
(共 13 行)`TOCItem 接口`

表示一个目录项

属性

属性名	说明	类型
`level`	当前目录项的缩进等级	`number`
`label`	当前目录项的文案	`string`
`anchor`	当前目录项的描点	`string`
`counter`(可选)	当前目录项的计数器	`string`
`items`(可选)	子级目录项展开子属性 `level`: `number` — 当前目录项的缩进等级 `label`: `string` — 当前目录项的文案 `anchor`: `string` — 当前目录项的描点 `counter`: `string` — 当前目录项的计数器 `items`: `array` — 子级目录项 `level`: `number` — 当前目录项的缩进等级 `label`: `string` — 当前目录项的文案 `anchor`: `string` — 当前目录项的描点 `counter`: `string` — 当前目录项的计数器 `items`: `(Circular)TOCItem[]` — 子级目录项	`TOCItem[]`

TocManager

筛选 API全部展开或折叠API

查看源码(共 153 行)TOCManager 类

构造函数

TOCManager查看源码(共 9 行)new TOCManager

参数

属性

方法

TOCManager查看源码(共 55 行)add

参数

返回值

TOCManager查看源码(共 16 行)addAnchor

参数

返回值

TOCManager查看源码(共 18 行)findItem

参数

返回值

TOCManager查看源码(共 7 行)findAnchor

参数

返回值

TOCManager查看源码(共 7 行)findLabel

参数

返回值

TOCManager查看源码(共 7 行)toAnchor

参数

返回值

查看源码(共 13 行)TOCItem 接口

属性

API

查看源码
(共 153 行)`TOCManager 类`

`TOCManager`查看源码
(共 9 行)`new TOCManager`

`TOCManager`查看源码
(共 55 行)`add`

`TOCManager`查看源码
(共 16 行)`addAnchor`

`TOCManager`查看源码
(共 18 行)`findItem`

`TOCManager`查看源码
(共 7 行)`findAnchor`

`TOCManager`查看源码
(共 7 行)`findLabel`

`TOCManager`查看源码
(共 7 行)`toAnchor`

查看源码
(共 13 行)`TOCItem 接口`