g6/packages/site/docs/apis/shape/WIP-ImageStyleProps.zh.md

813 lines
14 KiB
Markdown
Raw Normal View History

2023-08-31 22:06:26 +08:00
---
title: ImageStyleProps
---
2023-08-31 23:46:08 +08:00
> 📋 中文文档还在翻译中... 欢迎 PR
2023-08-31 22:06:26 +08:00
[Overview - v5.0.0-beta.21](../../README.zh.md) / [Modules](../../modules.zh.md) / [item](../../modules/item.zh.md) / ImageStyleProps
2023-08-31 22:06:26 +08:00
[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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### fillRule
2023-08-31 23:46:08 +08:00
`Optional` **fillRule**: `"nonzero"` \| `"evenodd"`
2023-08-31 22:06:26 +08:00
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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### pointerEvents
2023-08-31 23:46:08 +08:00
`Optional` **pointerEvents**: `"fill"` \| `"stroke"` \| `"visible"` \| `CSSGlobalKeywords` \| `"none"` \| `"auto"` \| `"painted"` \| `"visiblestroke"` \| `"visiblefill"` \| `"visiblepainted"` \| `"all"` \| `"non-transparent-pixel"`
2023-08-31 22:06:26 +08:00
**`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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### shadowType
2023-08-31 23:46:08 +08:00
`Optional` **shadowType**: `"both"` \| `"inner"` \| `"outer"`
2023-08-31 22:06:26 +08:00
#### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### textTransform
2023-08-31 23:46:08 +08:00
`Optional` **textTransform**: `""` \| `TextTransform`
2023-08-31 22:06:26 +08:00
**`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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### visibility
2023-08-31 23:46:08 +08:00
`Optional` **visibility**: `"visible"` \| `CSSGlobalKeywords` \| `"hidden"`
2023-08-31 22:06:26 +08:00
**`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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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
2023-08-31 23:46:08 +08:00
---
2023-08-31 22:06:26 +08:00
### 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