Documentation / @ripl/core / GroupOptions
Interface: GroupOptions
Defined in: packages/core/src/core/group.ts:37
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:39 |
class? | OneOrMore<string> | One or more CSS-like class names used for querying and selection. | ElementOptions.class | packages/core/src/core/element.ts:187 |
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:189 |
direction? | Direction | Directionality used when rendering text. | BaseState.direction | packages/core/src/context/types.ts:188 |
fill? | string | Fill style (CSS colour, gradient, or pattern) used to paint filled regions. | BaseState.fill | packages/core/src/context/types.ts:184 |
filter? | string | CSS filter string applied to subsequent drawing operations (e.g. blur(4px)). | BaseState.filter | packages/core/src/context/types.ts:186 |
font? | string | CSS font shorthand used when rendering text. | BaseState.font | packages/core/src/context/types.ts:190 |
fontKerning? | FontKerning | Whether font kerning is applied when rendering text. | BaseState.fontKerning | packages/core/src/context/types.ts:192 |
globalCompositeOperation? | unknown | Compositing operation controlling how new drawing is blended with existing content. | BaseState.globalCompositeOperation | packages/core/src/context/types.ts:196 |
id? | string | Optional stable id; a unique type:uniqueId id is generated when omitted. | ElementOptions.id | packages/core/src/core/element.ts:185 |
lineCap? | LineCap | Cap style drawn at the endpoints of stroked lines. | BaseState.lineCap | packages/core/src/context/types.ts:198 |
lineDash? | number[] | Dash pattern as alternating stroke and gap lengths; empty for a solid line. | BaseState.lineDash | packages/core/src/context/types.ts:200 |
lineDashOffset? | number | Distance into the line dash pattern at which dashing begins. | BaseState.lineDashOffset | packages/core/src/context/types.ts:202 |
lineJoin? | LineJoin | Join style drawn where two stroked segments meet. | BaseState.lineJoin | packages/core/src/context/types.ts:204 |
lineWidth? | number | Width, in pixels, of stroked lines. | BaseState.lineWidth | packages/core/src/context/types.ts:206 |
miterLimit? | number | Miter length limit ratio applied to miter line joins. | BaseState.miterLimit | packages/core/src/context/types.ts:208 |
opacity? | number | Global alpha applied to everything drawn, from 0 to 1. | BaseState.opacity | packages/core/src/context/types.ts:194 |
pointerEvents? | ElementPointerEvents | Which parts of the element respond to pointer hit testing. Defaults to all. | ElementOptions.pointerEvents | packages/core/src/core/element.ts:191 |
rotation? | Rotation | Rotation applied to the element's transform, as radians or a deg/rad string. | BaseState.rotation | packages/core/src/context/types.ts:234 |
shadowBlur? | number | Gaussian blur radius applied to drawn shadows. | BaseState.shadowBlur | packages/core/src/context/types.ts:210 |
shadowColor? | string | Colour of drawn shadows. | BaseState.shadowColor | packages/core/src/context/types.ts:212 |
shadowOffsetX? | number | Horizontal offset, in pixels, of drawn shadows. | BaseState.shadowOffsetX | packages/core/src/context/types.ts:214 |
shadowOffsetY? | number | Vertical offset, in pixels, of drawn shadows. | BaseState.shadowOffsetY | packages/core/src/context/types.ts:216 |
stroke? | string | Stroke style (CSS colour, gradient, or pattern) used to paint outlines. | BaseState.stroke | packages/core/src/context/types.ts:218 |
textAlign? | TextAlignment | Horizontal alignment of text relative to the drawing position. | BaseState.textAlign | packages/core/src/context/types.ts:220 |
textBaseline? | TextBaseline | Vertical baseline used when positioning text. | BaseState.textBaseline | packages/core/src/context/types.ts:222 |
transformOriginX? | TransformOrigin | Horizontal origin about which rotation and scaling are applied. | BaseState.transformOriginX | packages/core/src/context/types.ts:236 |
transformOriginY? | TransformOrigin | Vertical origin about which rotation and scaling are applied. | BaseState.transformOriginY | packages/core/src/context/types.ts:238 |
transformScaleX? | number | Horizontal scale factor applied to the element's transform. | BaseState.transformScaleX | packages/core/src/context/types.ts:230 |
transformScaleY? | number | Vertical scale factor applied to the element's transform. | BaseState.transformScaleY | packages/core/src/context/types.ts:232 |
translateX? | number | Horizontal translation, in pixels, applied to the element's transform. | BaseState.translateX | packages/core/src/context/types.ts:226 |
translateY? | number | Vertical translation, in pixels, applied to the element's transform. | BaseState.translateY | packages/core/src/context/types.ts:228 |
zIndex? | number | Stacking order used to sort elements during rendering; higher values draw on top. | BaseState.zIndex | packages/core/src/context/types.ts:224 |