Documentation / @ripl/core / GroupOptions
Interface: GroupOptions ​
Defined in: packages/core/src/core/group.ts:38
Options for constructing a group, extending element options with an optional initial set of children.
Extends ​
Extended by ​
Properties ​
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
children? | OneOrMore<Element<Partial<BaseState>, ElementEventMap>> | One or more child elements to add to the group on construction. | - | packages/core/src/core/group.ts:40 |
class? | OneOrMore<string> | One or more CSS-like class names used for querying and selection. | ElementOptions.class | packages/core/src/core/element.ts:238 |
data? | unknown | Arbitrary user data bound to the element, typically the datum backing a data-driven visual. | ElementOptions.data | packages/core/src/core/element.ts:240 |
direction? | Direction | Directionality used when rendering text. | BaseState.direction | packages/core/src/context/types.ts:229 |
fill? | string | Fill style (CSS color, gradient, or pattern) used to paint filled regions. | BaseState.fill | packages/core/src/context/types.ts:225 |
filter? | string | CSS filter string applied to subsequent drawing operations (e.g. blur(4px)). | BaseState.filter | packages/core/src/context/types.ts:227 |
font? | string | CSS font shorthand used when rendering text. | BaseState.font | packages/core/src/context/types.ts:231 |
fontKerning? | FontKerning | Whether font kerning is applied when rendering text. | BaseState.fontKerning | packages/core/src/context/types.ts:233 |
globalCompositeOperation? | unknown | Compositing operation controlling how new drawing is blended with existing content. | BaseState.globalCompositeOperation | packages/core/src/context/types.ts:237 |
id? | string | Optional stable id; a unique type:uniqueId id is generated when omitted. | ElementOptions.id | packages/core/src/core/element.ts:236 |
interpolators? | ElementInterpolators<Partial<BaseState>> | Interpolator overrides for individual state properties, layered over the defaults the element type declares. See ElementInterpolators. | ElementOptions.interpolators | packages/core/src/core/element.ts:244 |
lineCap? | LineCap | Cap style drawn at the endpoints of stroked lines. | BaseState.lineCap | packages/core/src/context/types.ts:239 |
lineDash? | number[] | Dash pattern as alternating stroke and gap lengths; empty for a solid line. | BaseState.lineDash | packages/core/src/context/types.ts:241 |
lineDashOffset? | number | Distance into the line dash pattern at which dashing begins. | BaseState.lineDashOffset | packages/core/src/context/types.ts:243 |
lineJoin? | LineJoin | Join style drawn where two stroked segments meet. | BaseState.lineJoin | packages/core/src/context/types.ts:245 |
lineWidth? | number | Width, in pixels, of stroked lines. | BaseState.lineWidth | packages/core/src/context/types.ts:247 |
miterLimit? | number | Miter length limit ratio applied to miter line joins. | BaseState.miterLimit | packages/core/src/context/types.ts:249 |
opacity? | number | Global alpha applied to everything drawn, from 0 to 1. | BaseState.opacity | packages/core/src/context/types.ts:235 |
pointerEvents? | ElementPointerEvents | Which parts of the element respond to pointer hit testing. Defaults to all. | ElementOptions.pointerEvents | packages/core/src/core/element.ts:242 |
rotation? | Rotation | Rotation applied to the element's transform, as radians or a deg/rad string. | BaseState.rotation | packages/core/src/context/types.ts:275 |
shadowBlur? | number | Gaussian blur radius applied to drawn shadows. | BaseState.shadowBlur | packages/core/src/context/types.ts:251 |
shadowColor? | string | Color of drawn shadows. | BaseState.shadowColor | packages/core/src/context/types.ts:253 |
shadowOffsetX? | number | Horizontal offset, in pixels, of drawn shadows. | BaseState.shadowOffsetX | packages/core/src/context/types.ts:255 |
shadowOffsetY? | number | Vertical offset, in pixels, of drawn shadows. | BaseState.shadowOffsetY | packages/core/src/context/types.ts:257 |
stroke? | string | Stroke style (CSS color, gradient, or pattern) used to paint outlines. | BaseState.stroke | packages/core/src/context/types.ts:259 |
textAlign? | TextAlignment | Horizontal alignment of text relative to the drawing position. | BaseState.textAlign | packages/core/src/context/types.ts:261 |
textBaseline? | TextBaseline | Vertical baseline used when positioning text. | BaseState.textBaseline | packages/core/src/context/types.ts:263 |
transformOriginX? | TransformOrigin | Horizontal origin about which rotation and scaling are applied. | BaseState.transformOriginX | packages/core/src/context/types.ts:277 |
transformOriginY? | TransformOrigin | Vertical origin about which rotation and scaling are applied. | BaseState.transformOriginY | packages/core/src/context/types.ts:279 |
transformScaleX? | number | Horizontal scale factor applied to the element's transform. | BaseState.transformScaleX | packages/core/src/context/types.ts:271 |
transformScaleY? | number | Vertical scale factor applied to the element's transform. | BaseState.transformScaleY | packages/core/src/context/types.ts:273 |
translateX? | number | Horizontal translation, in pixels, applied to the element's transform. | BaseState.translateX | packages/core/src/context/types.ts:267 |
translateY? | number | Vertical translation, in pixels, applied to the element's transform. | BaseState.translateY | packages/core/src/context/types.ts:269 |
zIndex? | number | Stacking order used to sort elements during rendering; higher values draw on top. | BaseState.zIndex | packages/core/src/context/types.ts:265 |