Published-release documentation · release compatibility

Advanced Chart 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.

encodeChannels

API layer: advanced. Authoring roles: H2.

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

encodeChannels(options: EncodeChannelsOptions): ChartProgram;

Named option contracts: EncodeChannelsOptions.

The following call patterns are abbreviated examples; the declaration above owns the complete option set.

encodeChannels({
  target,
  channels: {
    x?, y?, x2?, y2?, theta?, r?, xOffset?, yOffset?,
    group?, pathOrder?, color?, stroke?, size?, shape?, opacity?,
    strokeWidth?, strokeDash?, angle?, text?
  }
})

Atomically replace one or more encodings on one explicit mark. Each channel uses the same options and validation as its focused encode* action, without a nested target, coordinate, or id; a nested scale.id remains valid. The request must contain at least one of the 19 listed keys. Omitted channels are preserved, and null does not remove an encoding.

The action validates one final channel and scale state, then resolves affected scales and rematerializes each target, shared-scale consumer, dependent mark, and legend once. Channel object insertion order cannot change the result or trace order. Conflicting explicit properties for a shared scale ID fail before the original program changes. Rebound Cartesian axes keep their style and title; coupled default ticks and labels switch between categorical domain values and continuous count mode when the final scale family changes. Incompatible explicit guide values or a continuous-only grid make the whole request fail atomically. This advanced authoring action is available only from ggaction; use the focused encoding actions from ggaction/basic.

selectMarks

API layer: advanced. Authoring roles: H3.

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

selectMarks(options: SelectMarksOptions): ChartProgram;

Named option contracts: SelectMarksOptions.

The following call patterns are abbreviated examples; the declaration above owns the complete option set.

selectMarks({ id?, target?, grain?, field | channel | property, op, ...operatorOptions })

Store a reusable semantic final-item selection without changing graphics. Supported operators are eq, neq, gt, gte, lt, lte, oneOf, range, min, and max. grain defaults to "item"; stacked bars also support "stack". Fields are data values, channels are pre-scale semantic values, and properties are concrete graphical values. Mark selection and highlighting

editMarkSelection

API layer: advanced. Authoring roles: H3.

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

editMarkSelection(options: EditMarkSelectionOptions): ChartProgram;

Named option contracts: EditMarkSelectionOptions.

The following call patterns are abbreviated examples; the declaration above owns the complete option set.

editMarkSelection({ selection?, grain?, field | channel | property, op, ...operatorOptions })

Replace the complete selector while preserving the stored selection ID and mark target. Dependent highlights and exact categorical legend reflection are replayed from a clean baseline. Selection lifecycle

removeMarkSelection

API layer: advanced. Authoring roles: H3.

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

removeMarkSelection(options?: RemoveMarkSelectionOptions): ChartProgram;

Named option contracts: RemoveMarkSelectionOptions.

The following call patterns are abbreviated examples; the declaration above owns the complete option set.

removeMarkSelection({ selection? } = {})

Release one stored selection after removing its dependent highlight. Other selection and highlight assignments remain active. Selection lifecycle

Previous reference location

This contract moved: open the current action or shared contract.

Previous reference location

This contract moved: open the current action or shared contract.

Previous reference location

This contract moved: open the current action or shared contract.

Previous reference location

This contract moved: open the current action or shared contract.

Previous reference location

This contract moved: open the current action or shared contract.

Previous reference location

This contract moved: open the current action or shared contract.

Previous reference location

This contract moved: open the current action or shared contract.

Previous reference location

This contract moved: open the current action or shared contract.

Previous reference location

This contract moved: open the current action or shared contract.

Related

Action Reference · Chart API · Supported Features