Merge pull request #5133 from antvis/docs/shape

docs: update api shape docs
This commit is contained in:
Yanyan Wang 2023-11-13 12:54:35 +08:00 committed by GitHub
commit a022062775
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
62 changed files with 2072 additions and 15344 deletions

View File

@ -0,0 +1,36 @@
---
title: Circle
order: 0
---
## cx
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The x coordinate of the center of the circle
## cy
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The y coordinate of the center of the circle
## r
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The radius of the circle
<embed src="../../common/BaseStyleProps.en.md"></embed>

View File

@ -0,0 +1,36 @@
---
title: Circle 圆形
order: 0
---
## cx
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:圆心的 x 坐标
## cy
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:圆心的 y 坐标
## r
**类型**`number`
**默认值** `0`
**是否必须**false
**说明**:圆形的半径
<embed src="../../common/BaseStyleProps.zh.md"></embed>

View File

@ -0,0 +1,50 @@
---
title: Cube
order: 10
---
Cube Geometry
<img alt="cube" src="https://gw.alipayobjects.com/mdn/rms_6ae20b/afts/img/A*sHGXQpeIYzoAAAAAAAAAAAAAARQnAQ" height='200'/>
<embed src="../../common/Size.en.md"></embed>
## depth
**Type**: `number`
**Default**: `1`
**Required**: false
**Description**: depth
## widthSegments
**Type**: `number`
**Default**: `1`
**Required**: false
**Description**: width segments
## heightSegments
**Type**: `number`
**Default**: `1`
**Required**: false
**Description**: height segments
## depthSegments
**Type**: `number`
**Default**: `1`
**Required**: false
**Description**: depth segments

View File

@ -0,0 +1,48 @@
---
title: Cube 立方体
order: 10
---
<img alt="cube" src="https://gw.alipayobjects.com/mdn/rms_6ae20b/afts/img/A*sHGXQpeIYzoAAAAAAAAAAAAAARQnAQ" height='200'/>
<embed src="../../common/Size.zh.md"></embed>
## depth
**类型**`number`
**默认值**`1`
**是否必须**false
**说明**:深度
## widthSegments
**类型**`number`
**默认值**`1`
**是否必须**false
**说明**:宽度分段数
## heightSegments
**类型**`number`
**默认值**`1`
**是否必须**false
**说明**:高度分段数
## depthSegments
**类型**`number`
**默认值**`1`
**是否必须**false
**说明**:深度分段数

View File

@ -0,0 +1,46 @@
---
title: Ellipse
order: 7
---
## cx
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The x coordinate of the center of the ellipse
## cy
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The y coordinate of the center of the ellipse
## rx
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The horizontal radius of the ellipse
## ry
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The vertical radius of the ellipse
<embed src="../../common/BaseStyleProps.en.md"></embed>

View File

@ -0,0 +1,46 @@
---
title: Ellipse 椭圆
order: 7
---
## cx
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:椭圆心的 x 坐标
## cy
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:椭圆心的 y 坐标
## rx
**类型**`number`
**默认值** `0`
**是否必须**false
**说明**:椭圆的水平半径
## ry
**类型**`number`
**默认值** `0`
**是否必须**false
**说明**:椭圆的垂直半径
<embed src="../../common/BaseStyleProps.zh.md"></embed>

View File

@ -0,0 +1,28 @@
---
title: Image
order: 3
---
<embed src="../../common/ShapeStyleProps.en.md"></embed>
## img
**Type**: `string` | `HTMLImageElement`
**Default**: `null`
**Required**: false
**Description**: image object
## src
**Type**: `string`
**Default**: `null`
**Required**: false
**Description**: image url
<embed src="../../common/BaseStyleProps.en.md"></embed>

View File

@ -0,0 +1,28 @@
---
title: Image 图片
order: 3
---
<embed src="../../common/ShapeStyleProps.zh.md"></embed>
## img
**类型**`string` | `HTMLImageElement`
**默认值**`null`
**是否必须**false
**说明**:图片对象
## src
**类型**`string`
**默认值**`null`
**是否必须**false
**说明**:图片地址
<embed src="../../common/BaseStyleProps.zh.md"></embed>

View File

@ -0,0 +1,86 @@
---
title: Line
order: 4
---
## x1
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The x coordinate of the start point
## y1
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The y coordinate of the start point
## x2
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The x coordinate of the end point
## y2
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The y coordinate of the end point
## markerStart
**Type**: `DisplayObject`
**Default**: `null`
**Required**: false
**Description**: Marker at the start point
## markerEnd
**Type**: `DisplayObject`
**Default**: `null`
**Required**: false
**Description**: Marker at the end point
## markerStartOffset
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The offset of the start marker
## markerEndOffset
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The offset of the end marker
<embed src="../../common/BaseStyleProps.en.md"></embed>

View File

@ -0,0 +1,86 @@
---
title: Line 直线
order: 4
---
## x1
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:起点的 x 坐标
## y1
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:起点的 y 坐标
## x2
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:终点的 x 坐标
## y2
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:终点的 y 坐标
## markerStart
**类型**`DisplayObject`
**默认值**`null`
**是否必须**false
**说明**:起点标记图形
## markerEnd
**类型**`DisplayObject`
**默认值**`null`
**是否必须**false
**说明**:终点标记图形
## markerStartOffset
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:起点标记图形在直线上的偏移量
## markerEndOffset
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:终点标记图形在直线上的偏移量
<embed src="../../common/BaseStyleProps.zh.md"></embed>

View File

@ -0,0 +1,18 @@
---
title: Path
order: 5
---
## path
**Type**: `string` | `PathCommand[]`
**Default**: `''`
**Required**: false
**Description**: Path string or path command array
<embed src="../../common/Marker.en.md"></embed>
<embed src="../../common/BaseStyleProps.en.md"></embed>

View File

@ -0,0 +1,18 @@
---
title: Path 路径
order: 5
---
## path
**类型**`string` | `PathCommand[]`
**默认值**`''`
**是否必须**false
**说明**:路径字符串或者路径命令数组
<embed src="../../common/Marker.zh.md"></embed>
<embed src="../../common/BaseStyleProps.zh.md"></embed>

View File

@ -0,0 +1,48 @@
---
title: Plane
order: 11
---
Plane geometry, default lying on the XZ plane
<img alt="plane" src="https://gw.alipayobjects.com/mdn/rms_6ae20b/afts/img/A*jN9zQp3RflAAAAAAAAAAAAAAARQnAQ" height='200'/>
## width
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: width
## depth
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: depth
## widthSegments
**Type**: `number`
**Default**: `1`
**Required**: false
**Description**: width segments
## depthSegments
**Type**: `number`
**Default**: `1`
**Required**: false
**Description**: depth segments

View File

@ -0,0 +1,48 @@
---
title: Plane 平面
order: 11
---
默认躺在 XZ 平面上
<img alt="plane" src="https://gw.alipayobjects.com/mdn/rms_6ae20b/afts/img/A*jN9zQp3RflAAAAAAAAAAAAAAARQnAQ" height='200'/>
## width
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:宽度
## depth
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:深度
## widthSegments
**类型**`number`
**默认值**`1`
**是否必须**false
**说明**:宽度分段数
## depthSegments
**类型**`number`
**默认值**`1`
**是否必须**false
**说明**:深度分段数

View File

@ -0,0 +1,28 @@
---
title: Polygon
order: 8
---
## points
**Type**: `number[]`
**Default**: `[]`
**Required**: false
**Description**: The vertex coordinate array of the polygon
## isClosed
**Type**: `boolean`
**Default**: `false`
**Required**: false
**Description**: Whether it is closed
<embed src="../../common/Marker.en.md"></embed>
<embed src="../../common/BaseStyleProps.en.md"></embed>

View File

@ -0,0 +1,28 @@
---
title: Polygon 多边形
order: 8
---
## points
**类型**`number[]`
**默认值**`[]`
**是否必须**false
**说明**:多边形的顶点坐标数组
## isClosed
**类型**`boolean`
**默认值**`false`
**是否必须**false
**说明**:是否闭合
<embed src="../../common/Marker.zh.md"></embed>
<embed src="../../common/BaseStyleProps.zh.md"></embed>

View File

@ -0,0 +1,8 @@
---
title: Polyline
order: 6
---
<embed src="../../common/Marker.en.md"></embed>
<embed src="../../common/BaseStyleProps.en.md"></embed>

View File

@ -0,0 +1,8 @@
---
title: Polyline 折线
order: 6
---
<embed src="../../common/Marker.zh.md"></embed>
<embed src="../../common/BaseStyleProps.zh.md"></embed>

View File

@ -0,0 +1,18 @@
---
title: Rect
order: 1
---
<embed src="../../common/ShapeStyleProps.en.md"></embed>
## radius
**Type**: `number` | `number[]`
**Default**: `0`
**Required**: false
**Description**: Radius of rounded corners
<embed src="../../common/BaseStyleProps.en.md"></embed>

View File

@ -0,0 +1,18 @@
---
title: Rect 矩形
order: 1
---
<embed src="../../common/ShapeStyleProps.zh.md"></embed>
## radius
**类型**`number` | `number[]`
**默认值**`0`
**是否必须**false
**说明**:圆角半径
<embed src="../../common/BaseStyleProps.zh.md"></embed>

View File

@ -0,0 +1,38 @@
---
title: Sphere
order: 9
---
Sphere Geometry
<img alt="sphere" src="https://gw.alipayobjects.com/mdn/rms_6ae20b/afts/img/A*bsj2S4upLBgAAAAAAAAAAAAAARQnAQ" height='200'/>
## radius
**Type**: `number`
**Default**: `0.5`
**Required**: false
**Description**: radius
## latitudeBands
**Type**: `number`
**Default**: `16`
**Required**: false
**Description**: latitude bands
## longitudeBands
**Type**: `number`
**Default**: `16`
**Required**: false
**Description**: longitude bands

View File

@ -0,0 +1,36 @@
---
title: Sphere
order: 9
---
<img alt="sphere" src="https://gw.alipayobjects.com/mdn/rms_6ae20b/afts/img/A*bsj2S4upLBgAAAAAAAAAAAAAARQnAQ" height='200'/>
## radius
**类型**`number`
**默认值**`0.5`
**是否必须**false
**说明**radius
## latitudeBands
**类型**`number`
**默认值**`16`
**是否必须**ffalse
**说明**latitude bands
## longitudeBands
**类型**`number`
**默认值**`16`
**是否必须**ffalse
**说明**longitude bands

View File

@ -0,0 +1,226 @@
---
title: Text
order: 2
---
## 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>

View File

@ -0,0 +1,226 @@
---
title: Text 文本
order: 2
---
## 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>

View File

@ -0,0 +1,48 @@
---
title: Torus
order: 12
---
Torus Geometry
<img alt="torus" src="https://gw.alipayobjects.com/mdn/rms_6ae20b/afts/img/A*So7oT4qDvLkAAAAAAAAAAAAAARQnAQ" height='200'/>
## tubeRadius
**Type**: `number`
**Default**: `0.2`
**Required**: false
**Description**: The radius of the tube
## ringRadius
**Type**: `number`
**Default**: `0.3`
**Required**: false
**Description**: The radius of the ring
## segments
**Type**: `number`
**Default**: `30`
**Required**: false
**Description**: The number of segments
## sides
**Type**: `number`
**Default**: `20`
**Required**: false
**Description**: The number of sides

View File

@ -0,0 +1,46 @@
---
title: Torus 圆环
order: 12
---
<img alt="torus" src="https://gw.alipayobjects.com/mdn/rms_6ae20b/afts/img/A*So7oT4qDvLkAAAAAAAAAAAAAARQnAQ" height='200'/>
## tubeRadius
**类型**`number`
**默认值**`0.2`
**是否必须**false
**说明**:管道半径
## ringRadius
**类型**`number`
**默认值**`0.3`
**是否必须**false
**说明**:环半径
## segments
**类型**`number`
**默认值**`30`
**是否必须**false
**说明**:分段数
## sides
**类型**`number`
**默认值**`20`
**是否必须**false
**说明**:边数

View File

@ -1,760 +0,0 @@
---
title: CircleStyleProps
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / CircleStyleProps
[item](../../modules/item.en.md).CircleStyleProps
## Hierarchy
- `BaseStyleProps`
**`CircleStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### cx
`Optional` **cx**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Circle.d.ts:5
---
### cy
`Optional` **cy**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Circle.d.ts:6
---
### cz
`Optional` **cz**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Circle.d.ts:7
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Circle.d.ts:9
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### r
**r**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Circle.d.ts:8
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,762 +0,0 @@
---
title: CircleStyleProps
---
> 📋 中文文档还在翻译中... 欢迎 PR
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / CircleStyleProps
[item](../../modules/item.zh.md).CircleStyleProps
## Hierarchy
- `BaseStyleProps`
**`CircleStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### cx
`Optional` **cx**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Circle.d.ts:5
---
### cy
`Optional` **cy**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Circle.d.ts:6
---
### cz
`Optional` **cz**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Circle.d.ts:7
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Circle.d.ts:9
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### r
**r**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Circle.d.ts:8
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,67 +0,0 @@
---
title: CubeGeometryProps
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / CubeGeometryProps
[item](../../modules/item.en.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

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

View File

@ -1,770 +0,0 @@
---
title: EllipseStyleProps
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / EllipseStyleProps
[item](../../modules/item.en.md).EllipseStyleProps
## Hierarchy
- `BaseStyleProps`
**`EllipseStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### cx
`Optional` **cx**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Ellipse.d.ts:5
---
### cy
`Optional` **cy**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Ellipse.d.ts:6
---
### cz
`Optional` **cz**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Ellipse.d.ts:7
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Ellipse.d.ts:10
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### rx
**rx**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Ellipse.d.ts:8
---
### ry
**ry**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Ellipse.d.ts:9
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,772 +0,0 @@
---
title: EllipseStyleProps
---
> 📋 中文文档还在翻译中... 欢迎 PR
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / EllipseStyleProps
[item](../../modules/item.zh.md).EllipseStyleProps
## Hierarchy
- `BaseStyleProps`
**`EllipseStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### cx
`Optional` **cx**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Ellipse.d.ts:5
---
### cy
`Optional` **cy**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Ellipse.d.ts:6
---
### cz
`Optional` **cz**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Ellipse.d.ts:7
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Ellipse.d.ts:10
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### rx
**rx**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Ellipse.d.ts:8
---
### ry
**ry**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Ellipse.d.ts:9
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,810 +0,0 @@
---
title: ImageStyleProps
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / ImageStyleProps
[item](../../modules/item.en.md).ImageStyleProps
## Hierarchy
- `BaseStyleProps`
**`ImageStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### billboardRotation
`Optional` **billboardRotation**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:13
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### height
`Optional` **height**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:11
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### img
`Optional` **img**: `string` \| `HTMLImageElement`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:8
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:12
---
### isSizeAttenuation
`Optional` **isSizeAttenuation**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:14
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### src
`Optional` **src**: `string` \| `HTMLImageElement`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:9
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### width
`Optional` **width**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:10
---
### x
`Optional` **x**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:5
---
### y
`Optional` **y**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:6
---
### z
`Optional` **z**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:7
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,812 +0,0 @@
---
title: ImageStyleProps
---
> 📋 中文文档还在翻译中... 欢迎 PR
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / ImageStyleProps
[item](../../modules/item.zh.md).ImageStyleProps
## Hierarchy
- `BaseStyleProps`
**`ImageStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### billboardRotation
`Optional` **billboardRotation**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:13
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### height
`Optional` **height**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:11
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### img
`Optional` **img**: `string` \| `HTMLImageElement`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:8
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:12
---
### isSizeAttenuation
`Optional` **isSizeAttenuation**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:14
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### src
`Optional` **src**: `string` \| `HTMLImageElement`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:9
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### width
`Optional` **width**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:10
---
### x
`Optional` **x**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:5
---
### y
`Optional` **y**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:6
---
### z
`Optional` **z**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Image.d.ts:7
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,828 +0,0 @@
---
title: LineStyleProps
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / LineStyleProps
[item](../../modules/item.en.md).LineStyleProps
## Hierarchy
- `BaseStyleProps`
**`LineStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:12
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### markerEnd
`Optional` **markerEnd**: `DisplayObject`<`any`, `any`\>
marker will be positioned at x2/y2
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:20
---
### markerEndOffset
`Optional` **markerEndOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:28
---
### markerStart
`Optional` **markerStart**: `DisplayObject`<`any`, `any`\>
marker will be positioned at x1/y1
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:16
---
### markerStartOffset
`Optional` **markerStartOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:24
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### x1
**x1**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:6
---
### x2
**x2**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:8
---
### y1
**y1**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:7
---
### y2
**y2**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:9
---
### z1
`Optional` **z1**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:10
---
### z2
`Optional` **z2**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:11
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,830 +0,0 @@
---
title: LineStyleProps
---
> 📋 中文文档还在翻译中... 欢迎 PR
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / LineStyleProps
[item](../../modules/item.zh.md).LineStyleProps
## Hierarchy
- `BaseStyleProps`
**`LineStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:12
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### markerEnd
`Optional` **markerEnd**: `DisplayObject`<`any`, `any`\>
marker will be positioned at x2/y2
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:20
---
### markerEndOffset
`Optional` **markerEndOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:28
---
### markerStart
`Optional` **markerStart**: `DisplayObject`<`any`, `any`\>
marker will be positioned at x1/y1
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:16
---
### markerStartOffset
`Optional` **markerStartOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:24
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### x1
**x1**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:6
---
### x2
**x2**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:8
---
### y1
**y1**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:7
---
### y2
**y2**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:9
---
### z1
`Optional` **z1**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:10
---
### z2
`Optional` **z2**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Line.d.ts:11
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,798 +0,0 @@
---
title: PathStyleProps
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / PathStyleProps
[item](../../modules/item.en.md).PathStyleProps
## Hierarchy
- `BaseStyleProps`
**`PathStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### d
`Optional` **d**: `string` \| `PathArray`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:9
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:27
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### markerEnd
`Optional` **markerEnd**: `DisplayObject`<`any`, `any`\>
marker will be positioned at the last point
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:17
---
### markerEndOffset
`Optional` **markerEndOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:26
---
### markerMid
`Optional` **markerMid**: `DisplayObject`<`any`, `any`\>
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:18
---
### markerStart
`Optional` **markerStart**: `DisplayObject`<`any`, `any`\>
marker will be positioned at the first point
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:13
---
### markerStartOffset
`Optional` **markerStartOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:22
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### path
`Optional` **path**: `string` \| `PathArray`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:8
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,800 +0,0 @@
---
title: PathStyleProps
---
> 📋 中文文档还在翻译中... 欢迎 PR
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / PathStyleProps
[item](../../modules/item.zh.md).PathStyleProps
## Hierarchy
- `BaseStyleProps`
**`PathStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### d
`Optional` **d**: `string` \| `PathArray`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:9
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:27
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### markerEnd
`Optional` **markerEnd**: `DisplayObject`<`any`, `any`\>
marker will be positioned at the last point
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:17
---
### markerEndOffset
`Optional` **markerEndOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:26
---
### markerMid
`Optional` **markerMid**: `DisplayObject`<`any`, `any`\>
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:18
---
### markerStart
`Optional` **markerStart**: `DisplayObject`<`any`, `any`\>
marker will be positioned at the first point
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:13
---
### markerStartOffset
`Optional` **markerStartOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:22
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### path
`Optional` **path**: `string` \| `PathArray`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Path.d.ts:8
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,47 +0,0 @@
---
title: PlaneGeometryProps
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / PlaneGeometryProps
[item](../../modules/item.en.md).PlaneGeometryProps
## Properties
### depth
**depth**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/PlaneGeometry.d.ts:5
---
### depthSegments
**depthSegments**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/PlaneGeometry.d.ts:7
---
### width
**width**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/PlaneGeometry.d.ts:4
---
### widthSegments
**widthSegments**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/PlaneGeometry.d.ts:6

View File

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

View File

@ -1,798 +0,0 @@
---
title: PolygonStyleProps
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / PolygonStyleProps
[item](../../modules/item.en.md).PolygonStyleProps
## Hierarchy
- `BaseStyleProps`
**`PolygonStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:24
---
### isClosed
`Optional` **isClosed**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:23
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### markerEnd
`Optional` **markerEnd**: `DisplayObject`<`any`, `any`\>
marker will be positioned at the last point
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:13
---
### markerEndOffset
`Optional` **markerEndOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:22
---
### markerMid
`Optional` **markerMid**: `DisplayObject`<`any`, `any`\>
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:14
---
### markerStart
`Optional` **markerStart**: `DisplayObject`<`any`, `any`\>
marker will be positioned at the first point
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:9
---
### markerStartOffset
`Optional` **markerStartOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:18
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### points
**points**: ([`number`, `number`, `number`] \| [`number`, `number`])[]
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:5
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,800 +0,0 @@
---
title: PolygonStyleProps
---
> 📋 中文文档还在翻译中... 欢迎 PR
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / PolygonStyleProps
[item](../../modules/item.zh.md).PolygonStyleProps
## Hierarchy
- `BaseStyleProps`
**`PolygonStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:24
---
### isClosed
`Optional` **isClosed**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:23
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### markerEnd
`Optional` **markerEnd**: `DisplayObject`<`any`, `any`\>
marker will be positioned at the last point
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:13
---
### markerEndOffset
`Optional` **markerEndOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:22
---
### markerMid
`Optional` **markerMid**: `DisplayObject`<`any`, `any`\>
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:14
---
### markerStart
`Optional` **markerStart**: `DisplayObject`<`any`, `any`\>
marker will be positioned at the first point
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:9
---
### markerStartOffset
`Optional` **markerStartOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:18
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### points
**points**: ([`number`, `number`, `number`] \| [`number`, `number`])[]
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polygon.d.ts:5
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,788 +0,0 @@
---
title: PolylineStyleProps
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / PolylineStyleProps
[item](../../modules/item.en.md).PolylineStyleProps
## Hierarchy
- `BaseStyleProps`
**`PolylineStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:25
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### markerEnd
`Optional` **markerEnd**: `DisplayObject`<`any`, `any`\>
marker will be positioned at the last point
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:15
---
### markerEndOffset
`Optional` **markerEndOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:24
---
### markerMid
`Optional` **markerMid**: `DisplayObject`<`any`, `any`\>
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:16
---
### markerStart
`Optional` **markerStart**: `DisplayObject`<`any`, `any`\>
marker will be positioned at the first point
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:11
---
### markerStartOffset
`Optional` **markerStartOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:20
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### points
**points**: ([`number`, `number`, `number`] \| [`number`, `number`])[]
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:7
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,790 +0,0 @@
---
title: PolylineStyleProps
---
> 📋 中文文档还在翻译中... 欢迎 PR
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / PolylineStyleProps
[item](../../modules/item.zh.md).PolylineStyleProps
## Hierarchy
- `BaseStyleProps`
**`PolylineStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:25
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### markerEnd
`Optional` **markerEnd**: `DisplayObject`<`any`, `any`\>
marker will be positioned at the last point
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:15
---
### markerEndOffset
`Optional` **markerEndOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:24
---
### markerMid
`Optional` **markerMid**: `DisplayObject`<`any`, `any`\>
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:16
---
### markerStart
`Optional` **markerStart**: `DisplayObject`<`any`, `any`\>
marker will be positioned at the first point
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:11
---
### markerStartOffset
`Optional` **markerStartOffset**: `number`
offset relative to original position
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:20
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### points
**points**: ([`number`, `number`, `number`] \| [`number`, `number`])[]
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Polyline.d.ts:7
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,782 +0,0 @@
---
title: RectStyleProps
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / RectStyleProps
[item](../../modules/item.en.md).RectStyleProps
## Hierarchy
- `BaseStyleProps`
**`RectStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### height
**height**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:9
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:10
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### radius
`Optional` **radius**: `string` \| `number` \| `number`[]
top-left, top-right, bottom-right, bottom-left
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:14
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### width
**width**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:8
---
### x
`Optional` **x**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:5
---
### y
`Optional` **y**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:6
---
### z
`Optional` **z**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:7
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,784 +0,0 @@
---
title: RectStyleProps
---
> 📋 中文文档还在翻译中... 欢迎 PR
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / RectStyleProps
[item](../../modules/item.zh.md).RectStyleProps
## Hierarchy
- `BaseStyleProps`
**`RectStyleProps`**
## Properties
### anchor
`Optional` **anchor**: `string` \| [`number`, `number`, `number`] \| [`number`, `number`] \| `Float32Array`
how do we define the 'position' of a shape?
eg. the default anchor of a Rect is top-left, we can change it to its' center [0.5, 0.5].
#### Inherited from
BaseStyleProps.anchor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:47
---
### class
`Optional` **class**: `string`
#### Inherited from
BaseStyleProps.class
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:34
---
### clipPath
`Optional` **clipPath**: `DisplayObject`<`any`, `any`\>
clip path
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/clip-path
#### Inherited from
BaseStyleProps.clipPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:68
---
### cursor
`Optional` **cursor**: `Cursor`
the cursor style when the target is active
#### Inherited from
BaseStyleProps.cursor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:63
---
### display
`Optional` **display**: `string`
#### Inherited from
BaseStyleProps.display
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:171
---
### draggable
`Optional` **draggable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drag
#### Inherited from
BaseStyleProps.draggable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:175
---
### droppable
`Optional` **droppable**: `boolean`
**`See`**
https://g-next.antv.vision/zh/docs/plugins/dragndrop#drop
#### Inherited from
BaseStyleProps.droppable
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:179
---
### fill
`Optional` **fill**: `string` \| `Pattern`
填充颜色
#### Inherited from
BaseStyleProps.fill
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:79
---
### fillOpacity
`Optional` **fillOpacity**: `string` \| `number`
填充透明度
#### Inherited from
BaseStyleProps.fillOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:81
---
### fillRule
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
The fill-rule attribute is a presentation attribute defining the algorithm to use to determine the inside part of a shape.
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/SVG/Attribute/fill-rule
#### Inherited from
BaseStyleProps.fillRule
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:86
---
### filter
`Optional` **filter**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/filter
#### Inherited from
BaseStyleProps.filter
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:162
---
### height
**height**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:9
---
### hitArea
`Optional` **hitArea**: `DisplayObject`<`any`, `any`\>
交互区域
#### Inherited from
BaseStyleProps.hitArea
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:105
---
### increasedLineWidthForHitTesting
`Optional` **increasedLineWidthForHitTesting**: `string` \| `number`
increased line width when hitting test
#### Inherited from
BaseStyleProps.increasedLineWidthForHitTesting
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:101
---
### isBillboard
`Optional` **isBillboard**: `boolean`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:10
---
### lineCap
`Optional` **lineCap**: `CanvasLineCap`
alias of strokeLinecap
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap
#### Inherited from
BaseStyleProps.lineCap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:114
---
### lineDash
`Optional` **lineDash**: `string` \| `number` \| (`string` \| `number`)[]
alias of strokeDasharray
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash
#### Inherited from
BaseStyleProps.lineDash
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:132
---
### lineDashOffset
`Optional` **lineDashOffset**: `number`
alias of strokeDashoffset
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset
#### Inherited from
BaseStyleProps.lineDashOffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:141
---
### lineJoin
`Optional` **lineJoin**: `CanvasLineJoin`
alias of strokeLinejoin
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin
#### Inherited from
BaseStyleProps.lineJoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:123
---
### lineWidth
`Optional` **lineWidth**: `string` \| `number`
alias if strokeWidth
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth
#### Inherited from
BaseStyleProps.lineWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:97
---
### miterLimit
`Optional` **miterLimit**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit
#### Inherited from
BaseStyleProps.miterLimit
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:170
---
### offsetDistance
`Optional` **offsetDistance**: `number`
#### Inherited from
BaseStyleProps.offsetDistance
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:74
---
### offsetPath
`Optional` **offsetPath**: `DisplayObject`<`any`, `any`\>
offset path
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Motion_Path
#### Inherited from
BaseStyleProps.offsetPath
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:73
---
### opacity
`Optional` **opacity**: `string` \| `number`
整体透明度
#### Inherited from
BaseStyleProps.opacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:88
---
### pointerEvents
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/pointer-events
#### Inherited from
BaseStyleProps.pointerEvents
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:55
---
### radius
`Optional` **radius**: `string` \| `number` \| `number`[]
top-left, top-right, bottom-right, bottom-left
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:14
---
### shadowBlur
`Optional` **shadowBlur**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur
#### Inherited from
BaseStyleProps.shadowBlur
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:146
---
### shadowColor
`Optional` **shadowColor**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor
#### Inherited from
BaseStyleProps.shadowColor
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:150
---
### shadowOffsetX
`Optional` **shadowOffsetX**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX
#### Inherited from
BaseStyleProps.shadowOffsetX
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:154
---
### shadowOffsetY
`Optional` **shadowOffsetY**: `number`
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY
#### Inherited from
BaseStyleProps.shadowOffsetY
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:158
---
### shadowType
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
#### Inherited from
BaseStyleProps.shadowType
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:142
---
### stroke
`Optional` **stroke**: `string` \| `Pattern`
#### Inherited from
BaseStyleProps.stroke
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:75
---
### strokeDasharray
`Optional` **strokeDasharray**: `string` \| (`string` \| `number`)[]
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
#### Inherited from
BaseStyleProps.strokeDasharray
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:127
---
### strokeDashoffset
`Optional` **strokeDashoffset**: `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
#### Inherited from
BaseStyleProps.strokeDashoffset
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:136
---
### strokeLinecap
`Optional` **strokeLinecap**: `CanvasLineCap`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
#### Inherited from
BaseStyleProps.strokeLinecap
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:109
---
### strokeLinejoin
`Optional` **strokeLinejoin**: `CanvasLineJoin`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
#### Inherited from
BaseStyleProps.strokeLinejoin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:118
---
### strokeOpacity
`Optional` **strokeOpacity**: `string` \| `number`
描边透明度
#### Inherited from
BaseStyleProps.strokeOpacity
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:77
---
### strokeWidth
`Optional` **strokeWidth**: `string` \| `number`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width
#### Inherited from
BaseStyleProps.strokeWidth
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:92
---
### textTransform
`Optional` **textTransform**: `""` \| `TextTransform`
**`See`**
https://developer.mozilla.org/zh-CN/docs/Web/CSS/text-transform
#### Inherited from
BaseStyleProps.textTransform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:166
---
### transform
`Optional` **transform**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform
#### Inherited from
BaseStyleProps.transform
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:38
---
### transformOrigin
`Optional` **transformOrigin**: `string`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
#### Inherited from
BaseStyleProps.transformOrigin
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:42
---
### visibility
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
**`See`**
https://developer.mozilla.org/en-US/docs/Web/CSS/visibility
#### Inherited from
BaseStyleProps.visibility
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:51
---
### width
**width**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:8
---
### x
`Optional` **x**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:5
---
### y
`Optional` **y**: `string` \| `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:6
---
### z
`Optional` **z**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/display-objects/Rect.d.ts:7
---
### zIndex
`Optional` **zIndex**: `number`
z-index in CSS
#### Inherited from
BaseStyleProps.zIndex
#### Defined in
node_modules/.pnpm/@antv+g-lite@1.2.12/node_modules/@antv/g-lite/dist/types.d.ts:59

View File

@ -1,37 +0,0 @@
---
title: SphereGeometryProps
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / SphereGeometryProps
[item](../../modules/item.en.md).SphereGeometryProps
## Properties
### latitudeBands
**latitudeBands**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/SphereGeometry.d.ts:5
---
### longitudeBands
**longitudeBands**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/SphereGeometry.d.ts:6
---
### radius
**radius**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/SphereGeometry.d.ts:4

View File

@ -1,39 +0,0 @@
---
title: SphereGeometryProps
---
> 📋 中文文档还在翻译中... 欢迎 PR
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / SphereGeometryProps
[item](../../modules/item.zh.md).SphereGeometryProps
## Properties
### latitudeBands
**latitudeBands**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/SphereGeometry.d.ts:5
---
### longitudeBands
**longitudeBands**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/SphereGeometry.d.ts:6
---
### radius
**radius**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/SphereGeometry.d.ts:4

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -1,47 +0,0 @@
---
title: TorusGeometryProps
---
[Overview - v5.0.0-beta.21](../../README.en.md) / [Modules](../../modules.en.md) / [item](../../modules/item.en.md) / TorusGeometryProps
[item](../../modules/item.en.md).TorusGeometryProps
## Properties
### ringRadius
**ringRadius**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/TorusGeometry.d.ts:5
---
### segments
**segments**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/TorusGeometry.d.ts:6
---
### sides
**sides**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/TorusGeometry.d.ts:7
---
### tubeRadius
**tubeRadius**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/TorusGeometry.d.ts:4

View File

@ -1,49 +0,0 @@
---
title: TorusGeometryProps
---
> 📋 中文文档还在翻译中... 欢迎 PR
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / TorusGeometryProps
[item](../../modules/item.zh.md).TorusGeometryProps
## Properties
### ringRadius
**ringRadius**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/TorusGeometry.d.ts:5
---
### segments
**segments**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/TorusGeometry.d.ts:6
---
### sides
**sides**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/TorusGeometry.d.ts:7
---
### tubeRadius
**tubeRadius**: `number`
#### Defined in
node_modules/.pnpm/@antv+g-plugin-3d@1.9.15/node_modules/@antv/g-plugin-3d/dist/geometries/TorusGeometry.d.ts:4

View File

@ -0,0 +1,270 @@
## anchor
**Type**: `string` | `number[]`
**Default**: `[0, 0]`
**Required**: false
**Description**: The origin (anchor) position of the graphic, based on the bounding box definition, ranging from `[0, 0]` to `[1, 1]`, where `[0, 0]` represents the top-left corner of the bounding box, and `[1, 1]` represents the bottom-right corner
- Circle, Ellipse at the center position `[0.5, 0.5]`
- Rect, Image, Line, Polyline, Polygon, Path at the top-left vertex position of the bounding box `[0, 0]`
- Text at the text anchor position, should use the textBaseline and textAlign properties to set, so setting this property is invalid
- Group has no geometric definition, so setting this property is invalid
## className
**Type**: `string`
**Default**: `''`
**Required**: false
**Description**: The value of the class attribute of the element. Multiple classes are separated by spaces
## clipPath
**Type**: `DisplayObject`
**Default**: `null`
**Required**: false
**Description**: Use clipping to create the displayable area of the element, where the part inside the area is displayed, and the part outside is hidden
## cursor
**Type**: `string`
**Default**: `'default'`
**Required**: false
**Description**: The style of the pointer when hovering over the element, optional values refer to: [CSS cursor](https://developer.mozilla.org/zh-CN/docs/Web/CSS/cursor)。
## fill
**Type**: `string`
**Default**: `'none'`
**Required**: false
**Description**: The color used to fill the shape
## fillOpacity
**Type**: `number`
**Default**: `1`
**Required**: false
**Description**: The opacity of the shape's fill, with a value range of `[0, 1]`
## fillRule
**Type**: `'nonzero' | 'evenodd'`
**Default**: `'nonzero'`
**Required**: false
**Description**: The rule for filling the shape
## filter
**Type**: `string`
**Default**: `'none'`
**Required**: false
**Description**: Filters can process an already generated image, such as blurring, highlighting, increasing contrast, etc
- `CSS Filter`https://developer.mozilla.org/en-US/docs/Web/CSS/filter
- `Canvas Filter`https://developer.mozilla.org/zh-CN/docs/Web/API/CanvasRenderingContext2D/filter
- `SVG Filter`https://developer.mozilla.org/zh-CN/docs/Web/SVG/Element/filter
- In WebGL, it is generally called post-processing
## lineCap
**Type**: `'butt' | 'round' | 'square'`
**Default**: `'butt'`
**Required**: false
**Description**: The style of the endpoints of the shape's stroke
- `'butt'` Default value. The end of the line segment ends in a square
- `'round'` The end of the line segment ends in a circle
- `'square'` The end of the line segment ends in a square, but adds a rectangle with the same width as the line segment and half the thickness of the line segment
## lineDash
**Type**: `number[]`
**Default**: `[]`
**Required**: false
**Description**: The dash style of the shape's stroke, with values in the array alternating between dash length and spacing
## lineDashOffset
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The dash offset for the shape's stroke
## lineJoin
**Type**: `'miter' | 'round' | 'bevel'`
**Default**: `'miter'`
**Required**: false
**Description**: The style of the stroke's joints
- `'miter'` Default value. By extending the outer edge of the connected part, it intersects at one point to form an additional rhombus area
- `'round'` By filling an additional sector with the center at the end of the connected part, the shape of the corner is drawn. The radius of the rounded corner is the width of the line segment
- `'bevel'` Fill an additional triangular area at the end of the connected part, and each part has its own independent rectangular corner
## lineWidth
**Type**: `number`
**Default**: `1`
**Required**: false
**Description**: The width of the shape's stroke
## miterLimit
**Type**: `number`
**Default**: `10`(Canvas) `4`(SVG)
**Required**: false
**Description**: When lineJoin is set to 'miter', this sets the miter limit ratio
## opacity
**Type**: `number`
**Default**: `1`
**Required**: false
**Description**: The opacity of the shape, with a value range of `[0, 1]`
## pointerEvents
**Type**: `'none'` | `'auto'` | `'stroke'` | `'fill'` | `'painted'` | `'visible'` | `'visiblestroke'` | `'visiblefill'` | `'visiblepainted'` | `'all'` | `'non-transparent-pixel'`
**Default**: `'auto'`
**Required**: false
**Description**: How the shape responds to interactive events, for reference: https://developer.mozilla.org/en-US/docs/Web/CSS/pointer-events
## shadowBlur
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The level of blur for the shadow, with higher values indicating more blur
## shadowColor
**Type**: `string`
**Default**: `'none'`
**Required**: false
**Description**: The color of the shadow
## shadowType
**Type**: `'inner'` | `'outer'`
**Default**: `'outer'`
**Required**: false
**Description**: The type of shadow
- `'outer'` Outer shadow, the shadow is outside the shape's fill or stroke
- `'inner'` Inner shadow, the shadow is inside the shape
## shadowOffsetX
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The offset of the shadow in the x-axis direction
## shadowOffsetY
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The offset of the shadow in the y-axis direction
## stroke
**Type**: `string`
**Default**: `'none'`
**Required**: false
**Description**: The color of the shape's stroke
## strokeOpacity
**Type**: `number`
**Default**: `1`
**Required**: false
**Description**: The opacity of the shape's stroke, with a value range of `[0, 1]`
## visibility
**Type**: `'visible' | 'hidden'`
**Default**: `'visible'`
**Required**: false
**Description**: The visibility of the element
## zIndex
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The z-index of the element, with higher values being closer to the top

View File

@ -0,0 +1,272 @@
## anchor
**类型**`string` | `number[]`
**默认值**`[0, 0]`
**是否必须**false
**说明**:图形的原点(锚点)位置,基于包围盒定义,取值范围 `[0, 0]` ~ `[1, 1]`,其中 `[0, 0]` 代表包围盒左上角,`[1, 1]` 代表右下角
不同图形的默认锚点如下,示例:
- CircleEllipse 为圆心位置 `[0.5, 0.5]`
- RectImageLinePolylinePolygonPath 为包围盒左上角顶点位置 `[0, 0]`
- Text 为文本锚点位置,应该使用 textBaseline 与 textAlign 这两个属性设置,因此设置此属性无效
- Group 无几何定义,因此设置此属性无效
## className
**类型**`string`
**默认值**`''`
**是否必须**false
**说明**:元素的 class 属性的值,多个 class 用空格分隔
## clipPath
**类型**`DisplayObject`
**默认值**`null`
**是否必须**false
**说明**:使用裁剪方式创建元素的可显示区域,区域内的部分显示,区域外的隐藏
## cursor
**类型**`string`
**默认值**`'default'`
**是否必须**false
**说明**:指针悬停在元素上时的样式,可选值参考:[CSS cursor](https://developer.mozilla.org/zh-CN/docs/Web/CSS/cursor)
## fill
**类型**`string`
**默认值**`'none'`
**是否必须**false
**说明**:图形填充的颜色
## fillOpacity
**类型**`number`
**默认值**`1`
**是否必须**false
**说明**:图形填充的透明度,取值范围为 `[0, 1]`
## fillRule
**类型**`'nonzero'` | `'evenodd'`
**默认值**`'nonzero'`
**是否必须**false
**说明**:图形填充的规则
## filter
**类型**`string`
**默认值**`'none'`
**是否必须**false
**说明**:滤镜可以对已生成的图像进行一些处理,例如模糊、高亮、提升对比度等
- `CSS Filter`https://developer.mozilla.org/en-US/docs/Web/CSS/filter
- `Canvas Filter`https://developer.mozilla.org/zh-CN/docs/Web/API/CanvasRenderingContext2D/filter
- `SVG Filter`https://developer.mozilla.org/zh-CN/docs/Web/SVG/Element/filter
- WebGL 中一般称作后处理
## lineCap
**类型**`'butt'` | `'round'` | `'square'`
**默认值**`'butt'`
**是否必须**false
**说明**:图形描边的端点样式
- `'butt'` 线段末端以方形结束
- `'round'` 线段末端以圆形结束
- `'square'` 线段末端以方形结束,但是增加了一个宽度和线段相同,高度是线段厚度一半的矩形区域
## lineDash
**类型**`number[]`
**默认值**`[]`
**是否必须**false
**说明**:图形描边的虚线样式,数组中的值依次为虚线长度,虚线间隔,虚线长度,虚线间隔,...
## lineDashOffset
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:图形描边的虚线偏移量
## lineJoin
**类型**`'miter'` | `'round'` | `'bevel'`
**默认值**`'miter'`
**是否必须**false
**说明**:连接处样式
- `'miter'` 通过延伸相连部分的外边缘,使其相交于一点,形成一个额外的菱形区域
- `'round'` 通过填充一个额外的,圆心在相连部分末端的扇形,绘制拐角的形状。 圆角的半径是线段的宽度
- `'bevel'` 在相连部分的末端填充一个额外的以三角形为底的区域, 每个部分都有各自独立的矩形拐角
## lineWidth
**类型**`number`
**默认值**`1`
**是否必须**false
**说明**:图形描边的宽度
## miterLimit
**类型**`number`
**默认值**`10`(Canvas) `4`(SVG)
**是否必须**false
**说明**:当 lineJoin 为 'miter' 时,设置斜接面限制比例
## opacity
**类型**`number`
**默认值**`1`
**是否必须**false
**说明**:图形的透明度,取值范围为 `[0, 1]`
## pointerEvents
**类型**`'none'` | `'auto'` | `'stroke'` | `'fill'` | `'painted'` | `'visible'` | `'visiblestroke'` | `'visiblefill'` | `'visiblepainted'` | `'all'` | `'non-transparent-pixel'`
**默认值**`'auto'`
**是否必须**false
**说明**设置图形如何响应交互事件可参考https://developer.mozilla.org/en-US/docs/Web/CSS/pointer-events
## shadowBlur
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:阴影的模糊级别,值越大越模糊
## shadowColor
**类型**`string`
**默认值**`'none'`
**是否必须**false
**说明**:阴影的颜色
## shadowType
**类型**`'inner'` | `'outer'`
**默认值**`'outer'`
**是否必须**false
**说明**:阴影类型
- `'outer'` 外阴影,阴影在图形填充或者描边的外侧
- `'inner'` 内阴影,阴影在图形内部
## shadowOffsetX
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:阴影在 x 轴方向的偏移量
## shadowOffsetY
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:阴影在 y 轴方向的偏移量
## stroke
**类型**`string`
**默认值**`'none'`
**是否必须**false
**说明**:图形描边的颜色
## strokeOpacity
**类型**`number`
**默认值**`1`
**是否必须**false
**说明**:图形描边的透明度,取值范围为 `[0, 1]`
## visibility
**类型**`'visible'` | `'hidden'`
**默认值**`'visible'`
**是否必须**false
**说明**:元素的可见性
## zIndex
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:元素的层级,值越大越靠上

View File

@ -0,0 +1,49 @@
## markerStart
**Type**: `DisplayObject`
**Default**: `null`
**Required**: false
**Description**: Marker at the start point
## markerMid
**Type**: `DisplayObject`
**Default**: `null`
**Required**: false
**Description**: Marker at the middle point
## markerEnd
**Type**: `DisplayObject`
**Default**: `null`
**Required**: false
**Description**: Marker at the end point
## markerStartOffset
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The offset of the start marker
## markerEndOffset
**Type**: `number`
**Default**: `0`
**Required**: false
**Description**: The offset of the end marker

View File

@ -0,0 +1,49 @@
## markerStart
**类型**`DisplayObject`
**默认值**`null`
**是否必须**false
**说明**:起点标记图形
## markerMid
**类型**`DisplayObject`
**默认值**`null`
**是否必须**false
**说明**:中点标记图形
## markerEnd
**类型**`DisplayObject`
**默认值**`null`
**是否必须**false
**说明**:终点标记图形
## markerStartOffset
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:起点标记图形在直线上的偏移量
## markerEndOffset
**类型**`number`
**默认值**`0`
**是否必须**false
**说明**:终点标记图形在直线上的偏移量

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

View File

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

View File

@ -0,0 +1,3 @@
<embed src="./Position.en.md"></embed>
<embed src="./Size.en.md"></embed>

View File

@ -0,0 +1,3 @@
<embed src="./Position.zh.md"></embed>
<embed src="./Size.zh.md"></embed>

View File

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

View File

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