docs: improve editor options
This commit is contained in:
@@ -10,7 +10,7 @@ instance.register.contextMenuList([
|
||||
{
|
||||
isDivider?: boolean;
|
||||
icon?: string;
|
||||
name?: string;
|
||||
name?: string; // 使用%s代表选区文本。示例:搜索:%s
|
||||
shortCut?: string;
|
||||
when?: (payload: IContextMenuContext) => boolean;
|
||||
callback?: (command: Command, context: IContextMenuContext) => any;
|
||||
|
||||
@@ -56,3 +56,47 @@ interface IEditorOption {
|
||||
cursor?: ICursorOption; // 光标样式。{width?: number; color?: string; dragWidth?: number; dragColor?: string;}
|
||||
}
|
||||
```
|
||||
|
||||
## 页眉配置
|
||||
|
||||
```typescript
|
||||
interface IHeader {
|
||||
top?: number; // 距离页面顶部大小。默认:30
|
||||
maxHeightRadio?: MaxHeightRatio; // 占页面最大高度比。默认:HALF
|
||||
}
|
||||
```
|
||||
|
||||
## 页脚配置
|
||||
|
||||
```typescript
|
||||
interface IFooter {
|
||||
bottom?: number; // 距离页面底部大小。默认:30
|
||||
maxHeightRadio?: MaxHeightRatio; // 占页面最大高度比。默认:HALF
|
||||
}
|
||||
```
|
||||
|
||||
## 页码配置
|
||||
|
||||
```typescript
|
||||
interface IPageNumber {
|
||||
bottom?: number; // 距离页面底部大小。默认:60
|
||||
size?: number; // 字体大小。默认:12
|
||||
font?: string; // 字体。默认:Yahei
|
||||
color?: string; // 字体颜色。默认:#000000
|
||||
rowFlex?: RowFlex; // 行对齐方式。默认:CENTER
|
||||
format?: string; // 页码格式。默认:{pageNo}。示例:第{pageNo}页/共{pageCount}页
|
||||
numberType?: NumberType; // 数字类型。默认:ARABIC
|
||||
}
|
||||
```
|
||||
|
||||
## 水印配置
|
||||
|
||||
```typescript
|
||||
interface IWatermark {
|
||||
data: string; // 文本。
|
||||
color?: string; // 颜色。默认:#AEB5C0
|
||||
opacity?: number; // 透明度。默认:0.3
|
||||
size?: number; // 字体大小。默认:200
|
||||
font?: string; // 字体。默认:Yahei
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user