test/g6
1
0
Fork 0
mirror of https://gitee.com/antv/g6.git synced 2024-11-30 10:48:24 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

docs: adjust common docs

Browse Source
This commit is contained in:
Chushen 2023-11-10 20:51:16 +08:00
parent 08bb287f9e
commit 53f995ba95
27 changed files with 549 additions and 2473 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/site/docs/apis/shape/ImageStyleProps.en.md
View File

@ -6,7 +6,7 @@ title: ImageStyleProps
## img
**Type**: `string | HTMLImageElement`
**Type**: `string` | `HTMLImageElement`
**Default**: `null`

2
packages/site/docs/apis/shape/ImageStyleProps.zh.md
View File

@ -6,7 +6,7 @@ title: ImageStyleProps
## img
**类型**：`string | HTMLImageElement`
**类型**：`string` | `HTMLImageElement`
**默认值**：`null`

4
packages/site/docs/apis/shape/PathStyleProps.en.md
View File

@ -4,7 +4,7 @@ title: PathStyleProps
## path
**Type**: `string | PathCommand[]`
**Type**: `string` | `PathCommand[]`
**Default**: `''`
@ -12,6 +12,6 @@ title: PathStyleProps
**Description**: Path string or path command array
<embed src="../../common/MarkerStyleProps.en.md"></embed>
<embed src="../../common/Marker.en.md"></embed>
<embed src="../../common/BaseStyleProps.en.md"></embed>

4
packages/site/docs/apis/shape/PathStyleProps.zh.md
View File

@ -4,7 +4,7 @@ title: PathStyleProps
## path
**类型**：`string | PathCommand[]`
**类型**：`string` | `PathCommand[]`
**默认值**：`''`
@ -12,6 +12,6 @@ title: PathStyleProps
**说明**：路径字符串或者路径命令数组
<embed src="../../common/MarkerStyleProps.zh.md"></embed>
<embed src="../../common/Marker.zh.md"></embed>
<embed src="../../common/BaseStyleProps.zh.md"></embed>

2
packages/site/docs/apis/shape/PolygonStyleProps.en.md
View File

@ -22,6 +22,6 @@ title: PolygonStyleProps
**Description**: Whether it is closed
<embed src="../../common/MarkerStyleProps.en.md"></embed>
<embed src="../../common/Marker.en.md"></embed>
<embed src="../../common/BaseStyleProps.en.md"></embed>

2
packages/site/docs/apis/shape/PolygonStyleProps.zh.md
View File

@ -22,6 +22,6 @@ title: PolygonStyleProps
**说明**：是否闭合
<embed src="../../common/MarkerStyleProps.zh.md"></embed>
<embed src="../../common/Marker.zh.md"></embed>
<embed src="../../common/BaseStyleProps.zh.md"></embed>

2
packages/site/docs/apis/shape/PolylineStyleProps.en.md
View File

@ -2,6 +2,6 @@
title: PolylineStyleProps
---
<embed src="../../common/MarkerStyleProps.en.md"></embed>
<embed src="../../common/Marker.en.md"></embed>
<embed src="../../common/BaseStyleProps.en.md"></embed>

2
packages/site/docs/apis/shape/PolylineStyleProps.zh.md
View File

@ -2,6 +2,6 @@
title: PolylineStyleProps
---
<embed src="../../common/MarkerStyleProps.zh.md"></embed>
<embed src="../../common/Marker.zh.md"></embed>
<embed src="../../common/BaseStyleProps.zh.md"></embed>

2
packages/site/docs/apis/shape/RectStyleProps.en.md
View File

@ -6,7 +6,7 @@ title: RectStyleProps
## radius
**Type**: `number | number[]`
**Type**: `number` | `number[]`
**Default**: `0`

2
packages/site/docs/apis/shape/RectStyleProps.zh.md
View File

@ -6,7 +6,7 @@ title: RectStyleProps
## radius
**类型**：`number | number[]`
**类型**：`number` | `number[]`
**默认值**：`0`

225
packages/site/docs/apis/shape/TextStyleProps.en.md Normal file
View File

@ -0,0 +1,225 @@
---
title: TextStyleProps
---
## dx
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The x-axis offset
## dy
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The y-axis offset
## fontFamily
**Type**: `string`
**Default**: `''`
**Required**: false
**Description**: font family
## fontSize
**Type**: `number`
**Default**: `10`
**Required**: false
**Description**: font size
## fontStyle
**Type**: `'normal'` | `'italic'` | `'oblique'`
**Default**: `'normal'`
**Required**: false
**Description**: font style
## fontVariant
**Type**: `'normal'` | `'small-caps'`
**Default**: `'normal'`
**Required**: false
**Description**: font variant
## fontWeight
**Type**: `'normal'` | `'bold'` | `'bolder'` | `'lighter'` | `number`
**Default**: `'normal'`
**Required**: false
**Description**: font weight
## leading
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: leading
## letterSpacing
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: letter spacing
## lineHeight
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: line height
## text
**Type**: `string`
**Default**: `''`
**Required**: false
**Description**: text content
## textAlign
**Type**: `'start'` | `'center'` | `'middle'` | `'end'` | `'left'` | `'right'`
**Default**: `'start'`
**Required**: false
**Description**: text align
## textBaseline
**Type**: `'top'` | `'hanging'` | `'middle'` | `'alphabetic'` | `'ideographic'` | `'bottom'`
**Default**: `'alphabetic'`
**Required**: false
**Description**: text baseline
## textDecorationColor
**Type**: `string`
**Default**: `''`
**Required**: false
**Description**: text decoration color
## textDecorationLine
**Type**: `'none'` | `'underline'` | `'overline'` | `'line-through'` | `'blink'`
**Default**: `'none'`
**Required**: false
**Description**: text decoration line
## textDecorationStyle
**Type**: `'solid'` | `'double'` | `'dotted'` | `'dashed'` | `'wavy'`
**Default**: `'solid'`
**Required**: false
**Description**: text decoration style
## textOverflow
**Type**: `'ellipsis'` | `'clip'` | `string`
**Default**: `'clip'`
**Required**: false
**Description**: text overflow
## textPath
**Type**: `Path`
**Default**: `''`
**Required**: false
**Description**: text path
## textPathSide
**Type**: `'left'` | `'right'`
**Default**: `'left'`
**Required**: false
**Description**: text path side
## textPathStartOffset
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: text path start offset
## wordWrap
**Type**: `boolean`
**Default**: `false`
**Required**: false
**Description**: word wrap
## wordWrapWidth
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: word wrap width
<embed src="../../common/Position.en.md"></embed>

225
packages/site/docs/apis/shape/TextStyleProps.zh.md Normal file
View File

@ -0,0 +1,225 @@
---
title: TextStyleProps
---
## dx
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：x 方向偏移量
## dy
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：y 方向偏移量
## fontFamily
**类型**：`string`
**默认值**：`''`
**是否必须**：false
**说明**：字体
## fontSize
**类型**：`number`
**默认值**：`10`
**是否必须**：false
**说明**：字体大小
## fontStyle
**类型**：`'normal'` | `'italic'` | `'oblique'`
**默认值**：`'normal'`
**是否必须**：false
**说明**：字体样式
## fontVariant
**类型**：`'normal'` | `'small-caps'`
**默认值**：`'normal'`
**是否必须**：false
**说明**：字体变体
## fontWeight
**类型**：`'normal'` | `'bold'` | `'bolder'` | `'lighter'` | `number`
**默认值**：`'normal'`
**是否必须**：false
**说明**：字体粗细
## leading
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：行距
## letterSpacing
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：字间距
## lineHeight
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：行高
## text
**类型**：`string`
**默认值**：`''`
**是否必须**：false
**说明**：文本内容
## textAlign
**类型**：`'start'` | `'center'` | `'middle'` | `'end'` | `'left'` | `'right'`
**默认值**：`'start'`
**是否必须**：false
**说明**：文本对齐方式
## textBaseline
**类型**：`'top'` | `'hanging'` | `'middle'` | `'alphabetic'` | `'ideographic'` | `'bottom'`
**默认值**：`'alphabetic'`
**是否必须**：false
**说明**：文本基线对齐方式
## textDecorationColor
**类型**：`string`
**默认值**：`''`
**是否必须**：false
**说明**：文本修饰线颜色
## textDecorationLine
**类型**：`'none'` | `'underline'` | `'overline'` | `'line-through'` | `'blink'`
**默认值**：`'none'`
**是否必须**：false
**说明**：文本修饰线
## textDecorationStyle
**类型**：`'solid'` | `'double'` | `'dotted'` | `'dashed'` | `'wavy'`
**默认值**：`'solid'`
**是否必须**：false
**说明**：文本修饰线样式
## textOverflow
**类型**：`'ellipsis'` | `'clip'` | `string`
**默认值**：`'clip'`
**是否必须**：false
**说明**：文本溢出处理方式
## textPath
**类型**：`Path`
**默认值**：`''`
**是否必须**：false
**说明**：文本路径
## textPathSide
**类型**：`'left'` | `'right'`
**默认值**：`'left'`
**是否必须**：false
**说明**：文本路径方向
## textPathStartOffset
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：文本路径起始偏移量
## wordWrap
**类型**：`boolean`
**默认值**：`false`
**是否必须**：false
**说明**：是否自动换行
## wordWrapWidth
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：自动换行宽度
<embed src="../../common/Position.zh.md"></embed>

69
packages/site/docs/apis/shape/WIP-CubeGeometryProps.zh.md
View File

@ -1,69 +0,0 @@
---
title: CubeGeometryProps
---
> 📋 中文文档还在翻译中... 欢迎 PR
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / CubeGeometryProps
[item](../../modules/item.zh.md).CubeGeometryProps
## Properties
### depth
• **depth**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/CubeGeometry.d.ts:6
---
### depthSegments
• **depthSegments**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/CubeGeometry.d.ts:9
---
### height
• **height**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/CubeGeometry.d.ts:4
---
### heightSegments
• **heightSegments**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/CubeGeometry.d.ts:8
---
### width
• **width**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/CubeGeometry.d.ts:5
---
### widthSegments
• **widthSegments**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/CubeGeometry.d.ts:7

11
packages/site/docs/apis/shape/WIP-IAnchorPositionMap.en.md
View File

@ -1,11 +0,0 @@
---
title: IAnchorPositionMap
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / IAnchorPositionMap
[item](../../modules/item.en.md).IAnchorPositionMap
## Indexable
▪ [key: `string`]: [`number`, `number`]

13
packages/site/docs/apis/shape/WIP-IAnchorPositionMap.zh.md
View File

@ -1,13 +0,0 @@
---
title: IAnchorPositionMap
---
> 📋 中文文档还在翻译中... 欢迎 PR
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / IAnchorPositionMap
[item](../../modules/item.zh.md).IAnchorPositionMap
## Indexable
▪ [key: `string`]: [`number`, `number`]

1127
packages/site/docs/apis/shape/WIP-TextStyleProps.en.md
View File

File diff suppressed because it is too large Load Diff

1129
packages/site/docs/apis/shape/WIP-TextStyleProps.zh.md
View File

File diff suppressed because it is too large Load Diff

8
packages/site/docs/common/BaseStyleProps.en.md
View File

@ -1,12 +1,6 @@
---
title: BaseStyleProps
---
BaseStyleProps are the basic style configuration items for all shapes. All shapes can use these configurations
## anchor
**Type**: `string | number[]`
**Type**: `string` | `number[]`
**Default**: `[0, 0]`

16
packages/site/docs/common/BaseStyleProps.zh.md
View File

@ -1,12 +1,6 @@
---
title: BaseStyleProps
---
BaseStyleProps 是所有图形的基础样式配置项，所有的图形都可以使用这些配置项
## anchor
**类型**：`string | number[]`
**类型**：`string` | `number[]`
**默认值**：`[0, 0]`
@ -73,7 +67,7 @@ BaseStyleProps 是所有图形的基础样式配置项，所有的图形都可
## fillRule
**类型**：`'nonzero' | 'evenodd'`
**类型**：`'nonzero'` | `'evenodd'`
**默认值**：`'nonzero'`
@ -98,7 +92,7 @@ BaseStyleProps 是所有图形的基础样式配置项，所有的图形都可
## lineCap
**类型**：`'butt' | 'round' | 'square'`
**类型**：`'butt'` | `'round'` | `'square'`
**默认值**：`'butt'`
@ -132,7 +126,7 @@ BaseStyleProps 是所有图形的基础样式配置项，所有的图形都可
## lineJoin
**类型**：`'miter' | 'round' | 'bevel'`
**类型**：`'miter'` | `'round'` | `'bevel'`
**默认值**：`'miter'`
@ -259,7 +253,7 @@ BaseStyleProps 是所有图形的基础样式配置项，所有的图形都可
## visibility
**类型**：`'visible' | 'hidden'`
**类型**：`'visible'` | `'hidden'`
**默认值**：`'visible'`

6
packages/site/docs/common/MarkerStyleProps.en.md → packages/site/docs/common/Marker.en.md
View File

@ -1,7 +1,3 @@
---
title: MarkerStyleProps
---
## markerStart
**Type**: `DisplayObject`
@ -50,4 +46,4 @@ title: MarkerStyleProps
**Required**: false
**Description**: The offset of the end marker
**Description**: The offset of the end marker

4
packages/site/docs/common/MarkerStyleProps.zh.md → packages/site/docs/common/Marker.zh.md
View File

@ -1,7 +1,3 @@
---
title: MarkerStyleProps
---
## markerStart
**类型**：`DisplayObject`

19
packages/site/docs/common/Position.en.md Normal file
View File

@ -0,0 +1,19 @@
## x
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: x position
## y
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: y position

19
packages/site/docs/common/Position.zh.md Normal file
View File

@ -0,0 +1,19 @@
## x
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：x 坐标
## y
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：y 坐标

44
packages/site/docs/common/ShapeStyleProps.en.md
View File

@ -1,43 +1,3 @@
---
title: ShapeStyleProps
---
<embed src="./Position.en.md"></embed>
## x
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: x position
## y
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: y position
## width
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: width
## height
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: height
<embed src="./Size.en.md"></embed>

45
packages/site/docs/common/ShapeStyleProps.zh.md
View File

@ -1,44 +1,3 @@
---
title: ShapeStyleProps
---
<embed src="./Position.zh.md"></embed>
## x
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：x 坐标
## y
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：y 坐标
## width
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：宽度
## height
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：高度
<embed src="./Size.zh.md"></embed>

19
packages/site/docs/common/Size.en.md Normal file
View File

@ -0,0 +1,19 @@
## width
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: width
## height
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: height

19
packages/site/docs/common/Size.zh.md Normal file
View File

@ -0,0 +1,19 @@
## width
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：宽度
## height
**类型**：`number`
**默认值**：`0`
**是否必须**：false
**说明**：高度