test/g6
1
0
Fork 0
mirror of https://gitee.com/antv/g6.git synced 2024-12-16 02:21:25 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
83ae26590b
g6/packages/site/docs/apis/interfaces/item/LineStyleProps.zh.md

831 lines
14 KiB
Markdown
Raw Normal View History

feat: update doc
2023-08-31 22:06:26 +08:00
---
title: LineStyleProps
---
> 📋 中文文档还在翻译中... 欢迎PR
[Overview - v5.0.0-beta.1](../../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
Reference in New Issue Copy Permalink