ggaction 0.0.22 → 0.0.24

package/src/actions/guides/axes/components.js

@@ -1,4 +1,5 @@
 import { axisGraphicIds } from "../../../materialization/guides/resources.js";
+import { isLabelRelativeTitleOffset } from "../../../grammar/axisTextPlacement.js";
 
 export const AXIS_COMPONENTS = Object.freeze(["line", "ticks", "labels", "title"]);
 
@@ -31,6 +32,10 @@ export function assertRemovableAxisComponent(program, channel, component, operat
 }
 
 export function removeAxisComponent(program, channel, component, axisId = channel) {
+  if (component === "labels" && isLabelRelativeTitleOffset(program.guideConfigs.axis?.[axisId]?.title?.offset) &&
+      program.context.pendingRelativeTitleAxis !== axisId) {
+    throw new Error("Remove the label-relative axis title together with its labels.");
+  }
   const id = axisComponentId(channel, component, axisId);
   let next = program;
   if (component === "title" && next.semanticSpec.guides.axis?.[axisId]?.title !== undefined) {

package/src/actions/guides/axes/edit.js

@@ -1,188 +1 @@
-import { selectCartesianAxis, axisTargetArgs, assertCartesianAxisSideAvailable } from "../../../selectors/axes.js";
-import { validateAxisPosition, resolveAxisFrameConfig } from "./policy.js";
-import { withGuideLayoutValidation } from "../../../materialization/guides/layout.js";
-import { action } from "../../../core/action.js";
-import { isPlainObject } from "../../../core/immutable.js";
-import { validateKeys, validateOptionObject, validateNonNegativeFinite } from "../../../core/validation.js";
-
-import {
-  AXIS_COMPONENTS,
-  axisComponentId as graphicId,
-  hasAxisComponent as hasComponent,
-  assertRemovableAxisComponent as assertRemovable,
-  removeAxisComponent as removeComponent
-} from "./components.js";
-
-const OPTIONS = Object.freeze([
-  "target", "position", "line", "ticks", "labels", "ticksAndLabels", "title", "offset", "underlay"
-]);
-const LINE_OPTIONS = Object.freeze(["color", "lineWidth"]);
-const TICK_OPTIONS = Object.freeze([
-  "count", "values", "rounding", "length", "color", "lineWidth", "alongOffset", "strokeDash", "strokeDashMap"
-]);
-const LABEL_OPTIONS = Object.freeze([
-  "count", "values", "rounding", "offset", "format", "color", "fontSize",
-  "fontFamily", "fontWeight", "rotation", "maxWidth", "wrap",
-  "lineHeight", "overlap", "alongOffset", "labelMap", "flush", "colorMap", "align"
-]);
-const GROUP_OPTIONS = Object.freeze(["count", "values", "rounding", "ticks", "labels"]);
-const TITLE_OPTIONS = Object.freeze([
-  "text", "at", "offset", "rotation", "color", "fontSize",
-  "fontFamily", "fontWeight", "alongOffset", "align", "baseline", "overlap"
-]);
-
-function validateNested(args, key, options, operation, { allowFalse = false } = {}) {
-  if (!Object.hasOwn(args, key)) return;
-  if (allowFalse && args[key] === false) return;
-  if (!isPlainObject(args[key])) {
-    const accepted = allowFalse ? "false or a plain object" : "a plain object";
-    throw new TypeError(`${operation}.${key} must be ${accepted}.`);
-  }
-  validateKeys(args[key], options, `${operation}.${key}`);
-}
-
-function validateArgs(args, operation) {
-  if (Object.hasOwn(args, "offset")) validateNonNegativeFinite(args.offset, "Axis frame offset");
-  resolveAxisFrameConfig(undefined, args);
-  validateOptionObject(args, OPTIONS, operation, {
-    allowEmpty: false,
-    emptyMessage: `${operation} requires at least one axis change.`,
-    emptyError: Error
-  });
-  const removable = { allowFalse: true };
-  validateNested(args, "line", LINE_OPTIONS, operation, removable);
-  validateNested(args, "ticks", TICK_OPTIONS, operation, removable);
-  validateNested(args, "labels", LABEL_OPTIONS, operation, removable);
-  validateNested(args, "ticksAndLabels", GROUP_OPTIONS, operation, removable);
-  validateNested(args, "title", TITLE_OPTIONS, operation, removable);
-  if (args.ticksAndLabels !== undefined && (
-    args.ticks !== undefined || args.labels !== undefined
-  )) {
-    throw new Error(
-      `${operation} cannot combine ticksAndLabels with ticks or labels.`
-    );
-  }
-  if (args.ticksAndLabels !== false && args.ticksAndLabels?.ticks !== undefined) {
-    validateNested(args.ticksAndLabels, "ticks", ["length", "color", "lineWidth", "alongOffset", "strokeDash", "strokeDashMap"], `${operation}.ticksAndLabels`);
-  }
-  if (args.ticksAndLabels !== false && args.ticksAndLabels?.labels !== undefined) {
-    validateNested(args.ticksAndLabels, "labels", [
-      "offset", "format", "color", "fontSize", "fontFamily", "fontWeight",
-      "rotation", "maxWidth", "wrap", "lineHeight", "overlap", "alongOffset", "labelMap", "flush", "colorMap", "align"
-    ], `${operation}.ticksAndLabels`);
-  }
-}
-
-function names(channel) {
-  const prefix = channel === "x" ? "X" : "Y";
-  return {
-    operation: `edit${prefix}Axis`,
-    line: `edit${prefix}AxisLine`,
-    ticks: `edit${prefix}AxisTicks`,
-    labels: `edit${prefix}AxisLabels`,
-    group: `edit${prefix}AxisTicksAndLabels`,
-    title: `edit${prefix}AxisTitle`,
-    remove: `remove${prefix}Axis`
-  };
-}
-
-function buildPlan(program, channel, args, operation, axisId = channel) {
-  const shared = { ...axisTargetArgs(axisId, channel),
-    ...(Object.hasOwn(args, "position") ? { position: args.position } : {}) };
-  const plan = [];
-  const addLeaf = (component, edit) => {
-    const value = args[component];
-    if (value === false) {
-      assertRemovable(program, channel, component, operation.operation, axisId);
-      plan.push({ kind: "remove", component });
-    } else if (value !== undefined) {
-      plan.push({ kind: "edit", operation: edit, args: { ...shared, ...value } });
-    } else if ((args.position !== undefined || Object.hasOwn(args, "offset") || Object.hasOwn(args, "underlay")) && hasComponent(program, channel, component, axisId)) {
-      plan.push({ kind: "edit", operation: edit, args: shared });
-    }
-  };
-
-  addLeaf("line", operation.line);
-  if (args.ticksAndLabels === false) {
-    assertRemovable(program, channel, "ticks", operation.operation, axisId);
-    assertRemovable(program, channel, "labels", operation.operation, axisId);
-    plan.push(
-      { kind: "remove", component: "ticks" },
-      { kind: "remove", component: "labels" }
-    );
-  } else if (args.ticksAndLabels !== undefined) {
-    plan.push({
-      kind: "edit",
-      operation: operation.group,
-      args: { ...shared, ...args.ticksAndLabels }
-    });
-  } else {
-    addLeaf("ticks", operation.ticks);
-    addLeaf("labels", operation.labels);
-  }
-  addLeaf("title", operation.title);
-
-  if (plan.length === 0) {
-    throw new Error(`${operation.operation} requires an existing ${channel}-axis component.`);
-  }
-  return plan;
-}
-
-function applyPlan(program, channel, plan, operation, axisId = channel) {
-  let next = program;
-  for (const step of plan) {
-    next = step.kind === "remove"
-      ? removeComponent(next, channel, step.component, axisId)
-      : next[step.operation](step.args);
-  }
-
-  const hasRetainedGraphic = AXIS_COMPONENTS.some(
-    component => next.graphicSpec.objects[graphicId(channel, component, axisId)] !== undefined
-  );
-  if (!hasRetainedGraphic && (
-    next.semanticSpec.guides.axis?.[axisId] !== undefined ||
-    next.guideConfigs.axis?.[axisId] !== undefined
-  )) {
-    next = next[operation.remove](axisId === channel ? undefined : axisTargetArgs(axisId, channel));
-  }
-  return next;
-}
-
-function makeEditAxis(channel) {
-  const operation = names(channel);
-  return action(
-    {
-      op: operation.operation,
-      description: `Edit selected existing ${channel}-axis components.`
-    },
-    withGuideLayoutValidation(function (args = {}) {
-      validateArgs(args, operation.operation);
-      const selected = selectCartesianAxis(this, channel, args, { whole: true });
-      const axisId = selected.id; args = selected.options;
-      let source = this;
-      if (selected.owner?.named && args.position !== undefined) {
-        const position = validateAxisPosition(channel, args.position);
-        assertCartesianAxisSideAvailable(this, { id: axisId, channel,
-          coordinate: selected.owner.coordinate, position });
-        source = source.editSemantic({ property: `guide.axis.${axisId}.position`, value: position });
-      }
-      const frame = resolveAxisFrameConfig(source.guideConfigs.axis?.[axisId]?.frame, args);
-      source = frame === undefined ? source._withoutMaterializationConfig(["guides", "axis", axisId, "frame"])
-        : source._withGuideConfig(axisId, "frame", frame);
-      const plan = buildPlan(source, channel, args, operation, axisId);
-
-      // Run the complete proposal against an immutable speculative branch so a
-      // later leaf failure cannot begin the returned action trace or state.
-      applyPlan(source, channel, plan, operation, axisId);
-      return applyPlan(source, channel, plan, operation, axisId);
-    })
-  );
-}
-
-const editXAxis = /* @__PURE__ */ makeEditAxis("x");
-const editYAxis = /* @__PURE__ */ makeEditAxis("y");
-
-export function registerCompleteAxisEditActions(ProgramClass) {
-  ProgramClass.prototype.editXAxis = editXAxis;
-  ProgramClass.prototype.editYAxis = editYAxis;
-}
+import{resolveAxisTickEditConfig as x}from"./ticks.js";import{resolveAxisLabelEditConfig as L}from"./labels.js";import{validateAxisTickGroupEditConfig as T}from"./tickGroups.js";import{selectCartesianAxis as w,axisTargetArgs as k,assertCartesianAxisSideAvailable as C}from"../../../selectors/axes.js";import{validateAxisPosition as $,resolveAxisFrameConfig as h}from"./policy.js";import{withGuideLayoutValidation as E,withPendingRelativeAxisTitle as j}from"../../../materialization/guides/layout.js";import{action as S}from"../../../core/action.js";import{applyMaterializationPlan as N}from"../../../materialization/planner.js";import{isPlainObject as u}from"../../../core/immutable.js";import{isLabelRelativeTitleOffset as O}from"../../../grammar/axisTextPlacement.js";import{validateKeys as P,validateOptionObject as g,validateNonNegativeFinite as y}from"../../../core/validation.js";import{AXIS_COMPONENTS as z,axisComponentId as M,hasAxisComponent as R,assertRemovableAxisComponent as m,removeAxisComponent as W}from"./components.js";const _=Object.freeze(["target","position","line","ticks","labels","ticksAndLabels","title","offset","underlay"]),G=Object.freeze(["color","lineWidth"]),F=Object.freeze(["count","values","rounding","length","color","lineWidth","alongOffset","strokeDash","strokeDashMap"]),D=Object.freeze(["count","values","rounding","offset","format","color","fontSize","fontFamily","fontWeight","rotation","maxWidth","wrap","lineHeight","overlap","alongOffset","labelMap","flush","flushThreshold","colorMap","align"]),X=Object.freeze(["count","values","rounding","ticks","labels"]),Y=Object.freeze(["text","at","offset","rotation","color","fontSize","fontFamily","fontWeight","alongOffset","align","baseline","overlap"]);function a(e,i,t,n,{allowFalse:o=!1}={}){if(Object.hasOwn(e,i)&&!(o&&e[i]===!1)){if(!u(e[i])){const f=o?"false or a plain object":"a plain object";throw new TypeError(`${n}.${i} must be ${f}.`)}P(e[i],t,`${n}.${i}`)}}function q(e,i){Object.hasOwn(e,"offset")&&y(e.offset,"Axis frame offset"),h(void 0,e),g(e,_,i,{allowEmpty:!1,emptyMessage:`${i} requires at least one axis change.`,emptyError:Error});const t={allowFalse:!0};if(a(e,"line",G,i,t),a(e,"ticks",F,i,t),a(e,"labels",D,i,t),a(e,"ticksAndLabels",X,i,t),a(e,"title",Y,i,t),e.ticksAndLabels!==void 0&&(e.ticks!==void 0||e.labels!==void 0))throw new Error(`${i} cannot combine ticksAndLabels with ticks or labels.`);e.ticksAndLabels!==!1&&e.ticksAndLabels?.ticks!==void 0&&a(e.ticksAndLabels,"ticks",["length","color","lineWidth","alongOffset","strokeDash","strokeDashMap"],`${i}.ticksAndLabels`),e.ticksAndLabels!==!1&&e.ticksAndLabels?.labels!==void 0&&a(e.ticksAndLabels,"labels",["offset","format","color","fontSize","fontFamily","fontWeight","rotation","maxWidth","wrap","lineHeight","overlap","alongOffset","labelMap","flush","flushThreshold","colorMap","align"],`${i}.ticksAndLabels`)}function H(e){const i=e==="x"?"X":"Y";return{operation:`edit${i}Axis`,line:`edit${i}AxisLine`,ticks:`edit${i}AxisTicks`,labels:`edit${i}AxisLabels`,group:`edit${i}AxisTicksAndLabels`,title:`edit${i}AxisTitle`,remove:`remove${i}Axis`}}function K(e,i,t,n){u(t.ticks)&&x(e,i,t.ticks,n),u(t.labels)&&L(e,i,t.labels,n),u(t.ticksAndLabels)&&T(e,i,t.ticksAndLabels,n)}function B(e,i,t,n,o=i){const f={...k(o,i),...Object.hasOwn(t,"position")?{position:t.position}:{}},l=[],d=(c,s)=>{const r=t[c];r===!1?(m(e,i,c,n.operation,o),l.push({kind:"remove",component:c})):r!==void 0?l.push({kind:"edit",operation:s,args:{...f,...r}}):(t.position!==void 0||Object.hasOwn(t,"offset")||Object.hasOwn(t,"underlay"))&&R(e,i,c,o)&&l.push({kind:"edit",operation:s,args:f})};if(d("line",n.line),t.ticksAndLabels===!1?(m(e,i,"ticks",n.operation,o),m(e,i,"labels",n.operation,o),l.push({kind:"remove",component:"ticks"},{kind:"remove",component:"labels"})):t.ticksAndLabels!==void 0?l.push({kind:"edit",operation:n.group,args:{...f,...t.ticksAndLabels}}):(d("ticks",n.ticks),d("labels",n.labels)),d("title",n.title),l.length===0)throw new Error(`${n.operation} requires an existing ${i}-axis component.`);return l}function p(e,i,t,n,o=i){if(O(e.guideConfigs.axis?.[o]?.title?.offset)&&t.some(s=>s.kind==="edit"&&s.operation===n.title)&&e.context.pendingRelativeTitleAxis!==o)return j(e,o,s=>p(s,i,t,n,o));let l=e;const d=O(e.guideConfigs.axis?.[o]?.title?.offset)&&t.some(s=>s.kind==="remove"&&s.component==="title")?[...t.filter(s=>s.kind==="remove"&&s.component==="title"),...t.filter(s=>!(s.kind==="remove"&&s.component==="title"))]:t;for(let s=0;s<d.length;){const r=d[s];if(r.kind==="remove"){l=W(l,i,r.component,o),s+=1;continue}const b=[];for(;s<d.length&&d[s].kind==="edit";){const A=d[s++];b.push({op:A.operation,args:A.args})}l=N(l,b)}return!z.some(s=>l.graphicSpec.objects[M(i,s,o)]!==void 0)&&(l.semanticSpec.guides.axis?.[o]!==void 0||l.guideConfigs.axis?.[o]!==void 0)&&(l=l[n.remove](o===i?void 0:k(o,i))),l}function v(e){const i=H(e);return S({op:i.operation,description:`Edit selected existing ${e}-axis components.`},E(function(t={}){q(t,i.operation);const n=w(this,e,t,{whole:!0}),o=n.id;t=n.options,K(this,e,t,o);let f=this;if(n.owner?.named&&t.position!==void 0){const c=$(e,t.position);C(this,{id:o,channel:e,coordinate:n.owner.coordinate,position:c}),f=f.editSemantic({property:`guide.axis.${o}.position`,value:c})}const l=h(f.guideConfigs.axis?.[o]?.frame,t);f=l===void 0?f._withoutMaterializationConfig(["guides","axis",o,"frame"]):f._withGuideConfig(o,"frame",l);const d=B(f,e,t,i,o);return p(f,e,d,i,o),p(f,e,d,i,o)}))}const U=v("x"),V=v("y");function de(e){e.prototype.editXAxis=U,e.prototype.editYAxis=V}export{de as registerCompleteAxisEditActions};