ggaction 0.0.24

Published-release documentation · release compatibility

Extension Actions

Each declared action has an exact signature and its own stable link. Option tables are generated from types; behavior prose names the owning workflow and its constraints. API layers and H0–H4 catalog role tags are independent classifications. Relative action hierarchy is determined by composition, not by a tag or fixed trace depth.

editSemantic

API layer: primitive. Authoring roles: H4.

Availability: Available by v0.0.13. See release compatibility.

editSemantic(options: EditSemanticOptions): ChartProgram;

Named option contracts: EditSemanticOptions.

Declared options

Generated from the current TypeScript declaration. Union branches can require different combinations; optional does not mean every combination is valid.

Option Presence Type
property Required string
value Optional / branch-dependent unknown
remove Optional / branch-dependent boolean \| undefined

Behavior, inference, resets, and errors: Extension and scale contracts.

createGraphics

API layer: primitive. Authoring roles: H4.

Availability: Available by v0.0.13. See release compatibility.

createGraphics(options: { id: string; type: GraphicType; length?: number; parent?: string; before?: string; after?: string; }): ChartProgram;

Named option contracts: GraphicType.

Declared options

Generated from the current TypeScript declaration. Union branches can require different combinations; optional does not mean every combination is valid.

Option Presence Type
id Required string
type Required GraphicType
length Optional / branch-dependent number \| undefined
parent Optional / branch-dependent string \| undefined
before Optional / branch-dependent string \| undefined
after Optional / branch-dependent string \| undefined

Behavior, inference, resets, and errors: Extension and scale contracts.

editGraphics

API layer: primitive. Authoring roles: H4.

Availability: Available by v0.0.13. See release compatibility.

editGraphics(options: EditGraphicsOptions): ChartProgram;

Named option contracts: EditGraphicsOptions.

Declared options

Generated from the current TypeScript declaration. Union branches can require different combinations; optional does not mean every combination is valid.

Option Presence Type
target Required string
property Optional / branch-dependent string \| undefined
value Optional / branch-dependent unknown
remove Optional / branch-dependent boolean \| undefined

Behavior, inference, resets, and errors: Extension and scale contracts.

Extension and scale contracts

Import action, registerExtension, and ChartProgram from ggaction/extension. Primitive methods are available on programs used by extension actions.

API Signature
Wrapper action({ op, description }, implementation)
Registration registerExtension({ name, actions })
Semantic primitive editSemantic({ property, value }) or editSemantic({ property, remove: true })
Graphic primitive createGraphics({ id, type, length?, parent?, before?, after? })
Graphic primitive editGraphics({ target, property, value }) or editGraphics({ target, remove: true })
Scale actions createScale({ id, type?, domain?, range?, nice?, zero?, clamp?, reverse?, base?, exponent?, constant?, paddingInner?, paddingOuter?, padding?, align?, palette?, interpolate?, midpoint?, radialMapping?, unknown? }), editScale({ id?, type?, domain?, range?, nice?, zero?, clamp?, reverse?, base?, exponent?, constant?, paddingInner?, paddingOuter?, padding?, align?, palette?, interpolate?, midpoint?, radialMapping?, unknown? })

Importing an extension package may register one validated batch of wrapped actions on the complete chart() program. Registration does not affect ggaction/basic, rejects collisions without partial installation, and requires each action key to match its wrapped op.

See Action authoring and Primitive API.

Action Reference · Chart API · Supported Features

Documentation provenance

293 actions · sha256:e755591a2e5f5e2b494867583876e28020a478c5220b77bdc6ad469a6224891d