ggaction 0.0.16 → 0.0.18

package/src/actions/guides/legends/group.js

@@ -0,0 +1 @@
+import{legendResourcePolicy as O}from"../../../materialization/guides/resources.js";import{LEGEND_POSITIONS as E,LEGEND_BLOCK_LAYOUTS as x}from"../../../core/vocabulary.js";import{validateLegendGroupState as v}from"../../../grammar/legendGroups.js";import{validateOptionObject as G,validateNonNegativeFinite as C}from"../../../core/validation.js";import{PLOT_LEGEND_POSITIONS as m}from"../../../layout/legend.js";import{legendGroup as _}from"../../../materialization/legendGroups.js";const N=E;function j(n){if(Object.hasOwn(n,"at")){if(G(n.at,["x","y"],"Legend at"),!Number.isFinite(n.at.x)||!Number.isFinite(n.at.y))throw new TypeError("Legend at requires finite x and y coordinates.");if(["position","align","offset"].some(e=>Object.hasOwn(n,e)))throw new Error("Legend at conflicts with position, align and offset in the same call.")}if(Object.hasOwn(n,"blockLayout")&&!x.includes(n.blockLayout))throw new Error("Legend blockLayout must be row, column or wrap.")}function y(n,e){return n.at!==void 0||e.at!==void 0?n.at!==void 0&&e.at!==void 0&&n.at.x===e.at.x&&n.at.y===e.at.y:n.position===e.position&&n.align===e.align&&n.offset===e.offset}function P(n,e,r,{creation:u=!1,corner:f=!1,nativeOffset:o=30}={}){j(e);const t=_(n,r),s=t!==void 0||e.at!==void 0||e.blockLayout!==void 0||f,{at:p,blockLayout:a,...l}=e;if(!s)return{program:n,options:l,grouped:!1};const g=Object.entries(n.guideConfigs.legend??{}).filter(([,d])=>d.target===r),w=g.map(([,d])=>d),h=g.find(([d])=>["series","color","stroke"].includes(d))?.[1].offset??o;if(w.some(d=>d.layout==="legacy-bottom")||e.layout==="legacy-bottom")throw new Error("Legend groups require edge layout.");let i;if(e.at!==void 0)i={at:{...e.at}};else if(e.position!==void 0){if(!N.includes(e.position))throw new Error(`Unsupported legend position "${e.position}".`);const d=m.includes(e.position),c=t?.placement.position===e.position;i={position:e.position,align:e.align??(c?t.placement.align:"center"),offset:e.offset??(c?t.placement.offset:d?8:h)}}else if(t!==void 0){if(i=t.placement.at===void 0?{...t.placement,...e.align===void 0?{}:{align:e.align},...e.offset===void 0?{}:{offset:e.offset}}:t.placement,t.placement.at!==void 0&&(e.align!==void 0||e.offset!==void 0))throw new Error("Free legend placement requires position before align or offset.")}else{const d=w.map(c=>({position:c.position,align:c.align,offset:c.offset}));if(d.length>1&&!d.every(c=>y(c,d[0])))throw new Error("Legend blockLayout requires an explicit anchor when existing blocks disagree.");i=d[0]??{position:"right",align:"center",offset:h}}if(i.position!==void 0){if(!["left","center","right"].includes(i.align))throw new Error("Unsupported legend group alignment.");if((m.includes(i.position)||["left","right"].includes(i.position))&&i.align!=="center")throw new Error("Side and in-plot legend groups require center alignment.");C(i.offset,"Legend group offset")}if(u&&t!==void 0&&(e.at!==void 0||e.position!==void 0||e.align!==void 0||e.offset!==void 0)&&!y(i,t.placement))throw new Error("New legend block anchor conflicts with its target group.");if(u&&t!==void 0&&e.blockLayout!==void 0&&e.blockLayout!==t.blockLayout)throw new Error("New legend blockLayout conflicts with its target group.");const b=e.blockLayout??t?.blockLayout??(i.at!==void 0?"column":m.includes(i.position)?"row":"wrap"),L={placement:i,blockLayout:b};v({[r]:L});const k=n._withMaterializationConfig(["guides","legendGroups",r],L);return i.position!==void 0&&(l.position=i.position,l.offset=i.offset,l.align=i.align),{program:k,options:l,grouped:!0}}function K(n,e){if(e.target!==void 0)return e.target;const r=e.channels,u=n.semanticSpec.layers.filter(f=>r===void 0?Object.keys(f.encoding??{}).some(o=>["color","stroke","shape","strokeDash","size","opacity","strokeWidth"].includes(o)&&f.encoding[o]?.scale!==void 0):r.every(o=>f.encoding?.[o]?.scale!==void 0));if(u.length!==1)throw new Error("Legend group requires one eligible target or an explicit target.");return u[0].id}function M(n,e,r,{creation:u=!1}={}){let f=e;for(const[o,t]of Object.entries(e.guideConfigs.legend??{})){const s=n.guideConfigs.legend?.[o];if(u&&s!==void 0||!u&&t===s)continue;const p=s??Object.entries(n.guideConfigs.legend??{}).find(([l,g])=>g.target===t.target&&O(l).semanticKind===O(o).semanticKind)?.[1],a=r.offset!==void 0?!1:u?!0:p?.inferredOffset===!0;f=f._withLegendConfig(o,{...t,inferredOffset:a})}for(const[o,t]of Object.entries(e.guideConfigs.legendGroups??{})){if(t.placement.at!==void 0){if(t.inferredOffset!==void 0){const{inferredOffset:a,...l}=t;f=f._withMaterializationConfig(["guides","legendGroups",o],l)}continue}const s=n.guideConfigs.legendGroups?.[o];if(t===s)continue;const p=r.offset!==void 0?!1:s?.placement.at!==void 0?!0:s!==void 0?s.inferredOffset===!0:Object.values(f.guideConfigs.legend??{}).filter(a=>a.target===o).every(a=>a.inferredOffset===!0);f=f._withMaterializationConfig(["guides","legendGroups",o],{...t,inferredOffset:p})}return f}export{K as creationLegendTarget,P as prepareLegendGroup,M as recordLegendOffsetIntent,j as validateLegendGroupOptions};

package/src/actions/guides/legends/lane.js

@@ -1,516 +1 @@
-import { editLegendBackground, resolveLegendBackgroundFromBounds } from "./continuous/common.js";
-import { action } from "../../../core/action.js";
-import { noOptions } from "../../../core/validation.js";
-import {
-  resolveConcreteGraphicBounds,
-  unionConcreteGraphicBounds
-} from "../../../grammar/schemas/graphicBounds.js";
-import { finiteMidpoint } from "../../../grammar/numeric.js";
-import { resolveGraphicBounds } from "../../../layout/canvas.js";
-import {
-  resolveHorizontalLegendLane,
-  resolveHorizontalLegendGroup,
-  resolveSingleHorizontalLegendPlacement,
-  isHorizontalEdgeLegend,
-  resolveSideLegendLane
-} from "../../../layout/legendLane.js";
-import { findCanvasGraphic } from
-  "../../../materialization/graphicHierarchy.js";
-import { legendResourcePolicy } from
-  "../../../materialization/guides/resources.js";
-
-const FAMILY_ORDER = Object.freeze({
-  series: 0,
-  color: 0,
-  stroke: 0,
-  gradient: 0,
-  interval: 0,
-  strokeGradient: 0,
-  strokeInterval: 0,
-  size: 1,
-  opacity: 2,
-  strokeWidth: 3
-});
-
-function categoricalFor(program, target) {
-  return ["series", "color", "stroke"]
-    .map(kind => program.guideConfigs.legend?.[kind])
-    .find(config => config?.target === target);
-}
-
-function legendPosition(program, kind, config) {
-  if (kind === "size") {
-    return categoricalFor(program, config.target)?.position ?? config.position;
-  }
-  return config.position;
-}
-
-function requestedOffset(config) {
-  return config.offset;
-}
-
-function existingIds(program, kind) {
-  return legendResourcePolicy(kind).graphicIds.filter(
-    id => program.graphicSpec.objects[id] !== undefined
-  );
-}
-
-function componentIds(program, kind) {
-  const ids = existingIds(program, kind);
-  const titleId = ids.find(id => id.endsWith("Title"));
-  const labelId = ids.find(id => id.endsWith("Labels"));
-  const backgroundId = ids.find(id => id.endsWith("Background"));
-  const symbolIds = ids.filter(id =>
-    id !== titleId && id !== labelId && id !== backgroundId
-  );
-  return { titleId, labelId, backgroundId, symbolIds };
-}
-
-function legendGraphicBounds(program, id) {
-  let bounds = resolveConcreteGraphicBounds(program.graphicSpec, id, program.materializationConfigs.textMetrics);
-  const graphic = program.graphicSpec.objects[id];
-  if (!id.includes("LegendSymbol") || graphic?.type !== "line") return bounds;
-  const properties = graphic.items?.map(item => item.properties) ??
-    [graphic.properties];
-  for (const item of properties) {
-    if (
-      Object.hasOwn(item, "lineCap") ||
-      typeof item.stroke !== "string" ||
-      !(item.strokeWidth > 0)
-    ) continue;
-    const extent = item.strokeWidth / 2;
-    bounds = {
-      left: Math.min(bounds.left, Math.min(item.x1, item.x2) - extent),
-      right: Math.max(bounds.right, Math.max(item.x1, item.x2) + extent),
-      top: Math.min(bounds.top, Math.min(item.y1, item.y2) - extent),
-      bottom: Math.max(bounds.bottom, Math.max(item.y1, item.y2) + extent)
-    };
-  }
-  return bounds;
-}
-
-function unionLegendBounds(program, ids) {
-  return ids.map(id => legendGraphicBounds(program, id))
-    .reduce((result, bounds) => result === undefined
-      ? bounds
-      : {
-          left: Math.min(result.left, bounds.left),
-          right: Math.max(result.right, bounds.right),
-          top: Math.min(result.top, bounds.top),
-          bottom: Math.max(result.bottom, bounds.bottom)
-        }, undefined);
-}
-
-function textAnchor(program, id) {
-  const graphic = program.graphicSpec.objects[id];
-  const properties = graphic.items?.[0]?.properties ?? graphic.properties;
-  return properties.x;
-}
-
-function blockDescriptor(program, kind, config) {
-  const components = componentIds(program, kind);
-  if (components.labelId === undefined || components.symbolIds.length === 0) {
-    throw new Error(`Legend lane requires complete ${kind} graphics.`);
-  }
-  const foregroundIds = [
-    ...components.symbolIds,
-    components.labelId,
-    ...(components.titleId === undefined ? [] : [components.titleId])
-  ];
-  const bounds = unionLegendBounds(program, foregroundIds);
-  const symbolAnchorIds = ["gradient", "strokeGradient"].includes(kind)
-    ? [kind === "gradient" ? "colorGradientStrips" : "strokeGradientStrips"]
-    : components.symbolIds;
-  const symbolAnchor = unionLegendBounds(program, symbolAnchorIds);
-  const symbolBounds = unionLegendBounds(program, components.symbolIds);
-  const labels = resolveConcreteGraphicBounds(
-    program.graphicSpec,
-    components.labelId
-  , program.materializationConfigs.textMetrics);
-  const title = components.titleId === undefined
-    ? undefined
-    : (() => {
-        const graphic = program.graphicSpec.objects[components.titleId];
-        const titleBounds = resolveConcreteGraphicBounds(
-          program.graphicSpec,
-          components.titleId
-        , program.materializationConfigs.textMetrics);
-        return {
-          x: graphic.properties.x,
-          y: graphic.properties.y,
-          fontSize: graphic.properties.fontSize,
-          width: titleBounds.right - titleBounds.left,
-          bounds: titleBounds
-        };
-      })();
-  if ([bounds, symbolAnchor, symbolBounds, labels].includes(undefined)) {
-    throw new Error(`Legend lane could not measure ${kind} graphics.`);
-  }
-  return {
-    id: kind,
-    kind,
-    target: config.target,
-    border: borderFor(kind, config),
-    offset: requestedOffset(config),
-    bounds,
-    title,
-    symbol: {
-      centerX: finiteMidpoint(symbolAnchor.left, symbolAnchor.right),
-      left: symbolBounds.left,
-      right: symbolBounds.right,
-      bounds: symbolAnchor
-    },
-    labels: {
-      x: textAnchor(program, components.labelId),
-      width: labels.right - labels.left
-    },
-    occupiedBounds: unionLegendBounds(program, [
-      ...foregroundIds,
-      ...(components.backgroundId === undefined ? [] : [components.backgroundId])
-    ]),
-    ...components,
-    foregroundIds
-  };
-}
-
-function borderFor(kind, config) {
-  return [
-    "series", "color", "stroke", "gradient", "strokeGradient", "opacity",
-    "interval", "strokeInterval", "strokeWidth", "size"
-  ].includes(kind)
-    ? config.border
-    : false;
-}
-
-function groupBlocks(blocks, configs) {
-  const groups = [];
-  for (let index = 0; index < blocks.length; index += 1) {
-    const block = blocks[index];
-    const config = configs[block.kind];
-    const next = blocks[index + 1];
-    if (
-      ["series", "color", "stroke"].includes(block.kind) &&
-      next?.kind === "size" && next.target === block.target
-    ) {
-      groups.push({
-        id: `${block.kind}+size`,
-        blocks: [block, next.backgroundId === undefined ? next : { ...next,
-          bounds: next.occupiedBounds, inset: next.border.padding + next.border.lineWidth / 2 }],
-        border: borderFor(block.kind, config),
-        backgroundId: block.backgroundId
-      });
-      index += 1;
-      continue;
-    }
-    groups.push({
-      id: block.kind,
-      blocks: [block],
-      border: borderFor(block.kind, config),
-      backgroundId: block.backgroundId
-    });
-  }
-  return groups;
-}
-
-function edgeKinds(program, edge) {
-  const configs = program.guideConfigs.legend ?? {};
-  const layerOrder = new Map(program.semanticSpec.layers.map(
-    (layer, index) => [layer.id, index]
-  ));
-  return Object.entries(configs)
-    .filter(([kind, config]) => legendPosition(program, kind, config) === edge)
-    .sort(([kindA, configA], [kindB, configB]) =>
-      (layerOrder.get(configA.target) - layerOrder.get(configB.target)) ||
-      (FAMILY_ORDER[kindA] - FAMILY_ORDER[kindB])
-    );
-}
-
-export function hasMultiSideLegendLane(program) {
-  return ["right", "left"].some(side => edgeKinds(program, side).length > 1);
-}
-
-export function hasHorizontalLegendLane(program) {
-  return ["top", "bottom"].some(edge => edgeKinds(program, edge).some(
-    ([, config]) => isHorizontalEdgeLegend({ ...config, position: edge })
-  ));
-}
-
-export function hasLegendLane(program) {
-  return hasMultiSideLegendLane(program) ||
-    hasHorizontalLegendLane(program);
-}
-
-function translateCommands(commands, dx, dy) {
-  return commands.map(command => {
-    if (command.op === "Z") return { ...command };
-    const next = {
-      ...command,
-      x: command.x + dx,
-      y: command.y + dy
-    };
-    if (command.op === "C") {
-      next.x1 = command.x1 + dx;
-      next.y1 = command.y1 + dy;
-      next.x2 = command.x2 + dx;
-      next.y2 = command.y2 + dy;
-    }
-    return next;
-  });
-}
-
-function translatedProperties(type, properties, dx, dy) {
-  const next = { ...properties };
-  if (["circle", "rect", "text"].includes(type)) {
-    next.x += dx;
-    next.y += dy;
-  } else if (type === "line") {
-    next.x1 += dx;
-    next.x2 += dx;
-    next.y1 += dy;
-    next.y2 += dy;
-  } else if (type === "path") {
-    next.commands = translateCommands(next.commands, dx, dy);
-  }
-  return next;
-}
-
-function translateGraphic(program, id, dx, dy) {
-  const graphic = program.graphicSpec.objects[id];
-  if (dx === 0 && dy === 0) return program;
-  if (graphic.items !== undefined) {
-    return program.editGraphics({
-      target: id,
-      property: "items",
-      value: graphic.items.map(item => ({
-        type: item.type ?? graphic.type,
-        properties: translatedProperties(
-          item.type ?? graphic.type,
-          item.properties,
-          dx,
-          dy
-        )
-      }))
-    });
-  }
-  let next = program;
-  const properties = translatedProperties(
-    graphic.type,
-    graphic.properties,
-    dx,
-    dy
-  );
-  for (const [property, value] of Object.entries(properties)) {
-    if (value !== graphic.properties[property]) {
-      next = next.editGraphics({ target: id, property, value });
-    }
-  }
-  return next;
-}
-
-function horizontalGroups(program, groups) {
-  return groups.map(group => {
-    const representative = group.blocks[0];
-    const config = program.guideConfigs.legend?.[representative.kind];
-    const atomic = group.blocks.length > 1;
-    const titleId = atomic ? undefined : representative.titleId;
-    const contentIds = group.blocks.flatMap(block => block.foregroundIds)
-      .filter(id => id !== titleId);
-    if (atomic) contentIds.push(...group.blocks.slice(1).flatMap(block =>
-      block.backgroundId === undefined ? [] : [block.backgroundId]));
-    const content = unionLegendBounds(program, contentIds);
-    const foreground = unionLegendBounds(
-      program,
-      [...contentIds, ...(titleId === undefined ? [] : [titleId])]
-    );
-    if (content === undefined || foreground === undefined) {
-      throw new Error(`Legend lane could not measure ${group.id} content.`);
-    }
-    const border = group.border;
-    const inset = border === false
-      ? 0
-      : border.padding + border.lineWidth / 2;
-    return {
-      id: group.id,
-      atomic,
-      titleId,
-      contentIds,
-      title: atomic ? undefined : representative.title,
-      inline: config?.titlePosition === "left",
-      element: atomic ? foreground : representative.symbol.bounds,
-      content,
-      horizontal: { left: foreground.left, right: foreground.right,
-        top: foreground.top, bottom: foreground.bottom },
-      inset,
-      padding: border === false ? 0 : border.padding,
-      backgroundId: group.backgroundId
-    };
-  });
-}
-
-function applyHorizontalPlan(program, groups, plan) {
-  let next = program;
-  const byId = new Map(groups.map(group => [group.id, group]));
-  for (const placement of plan.placements) {
-    const group = byId.get(placement.id);
-    if (group.titleId !== undefined) {
-      next = translateGraphic(next, group.titleId, placement.dx, placement.titleDy);
-    }
-    for (const id of group.contentIds) {
-      next = translateGraphic(next, id, placement.dx, placement.contentDy);
-    }
-    if (placement.background !== undefined) {
-      for (const property of ["x", "y", "width", "height"]) {
-        next = next.editGraphics({ target: placement.background.id, property,
-          value: placement.background[property] });
-      }
-    }
-  }
-  if (plan.background !== undefined) {
-    for (const property of ["x", "y", "width", "height"]) {
-      next = next.editGraphics({ target: plan.background.id, property,
-        value: plan.background[property] });
-    }
-  }
-  return next;
-}
-
-export const rematerializeSideLegendLane = /* @__PURE__ */ action(
-  {
-    op: "rematerializeSideLegendLane",
-    description: "Align and stack every right or left legend block."
-  },
-  function (args = {}) {
-    noOptions(args, "rematerializeSideLegendLane");
-    const plot = resolveGraphicBounds(this);
-    const canvas = findCanvasGraphic(this)?.properties;
-    if (plot === undefined || canvas === undefined) {
-      throw new Error("Legend lane requires resolved Canvas and plot bounds.");
-    }
-    const configs = this.guideConfigs.legend ?? {};
-    const plans = ["right", "left"].flatMap(side => {
-      const entries = edgeKinds(this, side);
-      if (entries.length < 2) return [];
-      const blocks = entries.map(([kind, config]) =>
-        blockDescriptor(this, kind, config)
-      );
-      const plan = resolveSideLegendLane({
-        side,
-        plot,
-        canvas,
-        groups: groupBlocks(blocks, configs)
-      });
-      return [{ plan, blocks }];
-    });
-    let next = this;
-    for (const { plan, blocks } of plans) {
-      const byId = new Map(blocks.map(block => [block.id, block]));
-      for (const placement of plan.placements) {
-        const block = byId.get(placement.id);
-        if (block.titleId !== undefined) {
-          next = translateGraphic(
-            next,
-            block.titleId,
-            placement.titleDx,
-            placement.dy
-          ).editGraphics({
-            target: block.titleId,
-            property: "textAlign",
-            value: "left"
-          });
-        }
-        for (const id of block.symbolIds) {
-          next = translateGraphic(
-            next,
-            id,
-            placement.symbolDx,
-            placement.dy
-          );
-        }
-        next = translateGraphic(
-          next,
-          block.labelId,
-          placement.labelDx,
-          placement.dy
-        ).editGraphics({
-          target: block.labelId,
-          property: "textAlign",
-          value: "left"
-        });
-      }
-      for (const block of blocks) {
-        if (block.backgroundId === undefined || plan.backgrounds.some(item => item.id === block.backgroundId)) continue;
-        const bounds = unionLegendBounds(next, block.foregroundIds);
-        const background = resolveLegendBackgroundFromBounds([bounds], block.border, canvas, "Legend");
-        next = editLegendBackground(next, block.backgroundId, background, block.border);
-      }
-      for (const background of plan.backgrounds) {
-        for (const property of ["x", "y", "width", "height"]) {
-          next = next.editGraphics({
-            target: background.id,
-            property,
-            value: background[property]
-          });
-        }
-      }
-    }
-    return next;
-  }
-);
-
-export const rematerializeHorizontalLegendLane = /* @__PURE__ */ action(
-  {
-    op: "rematerializeHorizontalLegendLane",
-    description: "Pack and align every top or bottom legend block."
-  },
-  function (args = {}) {
-    noOptions(args, "rematerializeHorizontalLegendLane");
-    const plot = resolveGraphicBounds(this);
-    const canvas = findCanvasGraphic(this)?.properties;
-    if (plot === undefined || canvas === undefined) {
-      throw new Error("Legend lane requires resolved Canvas and plot bounds.");
-    }
-    const configs = this.guideConfigs.legend ?? {};
-    let next = this;
-    for (const edge of ["top", "bottom"]) {
-      const entries = edgeKinds(next, edge).filter(
-        ([, config]) => isHorizontalEdgeLegend({ ...config, position: edge })
-      );
-      if (entries.length === 0) continue;
-      if (entries.length === 1) {
-        const [kind, config] = entries[0];
-        const ids = existingIds(next, kind);
-        const bounds = unionConcreteGraphicBounds(next.graphicSpec, ids, next.materializationConfigs.textMetrics);
-        const { dx, dy } = resolveSingleHorizontalLegendPlacement({
-          plot, canvas, config, bounds
-        });
-        for (const id of ids) next = translateGraphic(next, id, dx, dy);
-        continue;
-      }
-      let groups = groupBlocks(entries.map(([kind, config]) =>
-        blockDescriptor(next, kind, config)), configs);
-      for (const group of groups.filter(group => group.blocks.length > 1)) {
-        const config = configs[group.blocks[0].kind];
-        const children = horizontalGroups(next, group.blocks.map((block, index) => ({
-          id: block.id, blocks: [block], border: index === 0 ? false : block.border,
-          backgroundId: index === 0 ? undefined : block.backgroundId
-        }))).map(child => ({ ...child, element: child.content }));
-        const plan = resolveHorizontalLegendGroup({ edge, plot, canvas, groups: children,
-          align: config.align, offset: config.offset, border: group.border,
-          backgroundId: group.backgroundId });
-        next = applyHorizontalPlan(next, children, plan);
-      }
-      if (groups.length < 2) continue;
-      groups = groupBlocks(entries.map(([kind, config]) =>
-        blockDescriptor(next, kind, config)), configs);
-      const horizontal = horizontalGroups(next, groups);
-      const plan = resolveHorizontalLegendLane({
-        edge,
-        plot,
-        canvas,
-        groups: horizontal
-      });
-      next = applyHorizontalPlan(next, horizontal, plan);
-    }
-    return next;
-  }
-);
+import{resolveLegendAxisOffset as k,effectiveLegendOffsetConfig as E}from"../../../materialization/guides/resources.js";import{resolveLegendGroupPlacement as q}from"../../../layout/legendGroup.js";import{legendGroup as F}from"../../../materialization/legendGroups.js";import{editLegendBackground as $,resolveLegendBackgroundFromBounds as R}from"./continuous/common.js";import{action as v}from"../../../core/action.js";import{noOptions as z}from"../../../core/validation.js";import{resolveConcreteGraphicBounds as G,unionConcreteGraphicBounds as O}from"../../../grammar/schemas/graphicBounds.js";import{finiteMidpoint as T}from"../../../grammar/numeric.js";import{resolveGraphicBounds as M}from"../../../layout/canvas.js";import{resolveHorizontalLegendLane as K,resolveHorizontalLegendGroup as X,resolveSingleHorizontalLegendPlacement as j,isHorizontalEdgeLegend as P,resolveSideLegendLane as Y,resolveSingleSideLegendPlacement as Z}from"../../../layout/legendLane.js";import{findCanvasGraphic as S}from"../../../materialization/graphicHierarchy.js";import{legendResourcePolicy as _}from"../../../materialization/guides/resources.js";const x=Object.freeze({series:0,color:0,stroke:0,gradient:0,interval:0,strokeGradient:0,strokeInterval:0,size:1,opacity:2,strokeWidth:3});function J(r,i){return["series","color","stroke"].map(t=>r.guideConfigs.legend?.[t]).find(t=>t?.target===i)}function N(r,i,t){return i==="size"&&t.inheritPosition!==!1?J(r,t.target)?.position??t.position:t.position}function Q(r){return r.offset}function m(r,i){return _(i).graphicIds.filter(t=>r.graphicSpec.objects[t]!==void 0)}function U(r,i){const t=m(r,i),o=t.find(c=>c.endsWith("Title")),e=t.find(c=>c.endsWith("Labels")),n=t.find(c=>c.endsWith("Background")),s=t.filter(c=>c!==o&&c!==e&&c!==n);return{titleId:o,labelId:e,backgroundId:n,symbolIds:s}}function V(r,i){let t=G(r.graphicSpec,i,r.materializationConfigs.textMetrics);const o=r.graphicSpec.objects[i];if(!i.includes("LegendSymbol")||o?.type!=="line")return t;const e=o.items?.map(n=>n.properties)??[o.properties];for(const n of e){if(Object.hasOwn(n,"lineCap")||typeof n.stroke!="string"||!(n.strokeWidth>0))continue;const s=n.strokeWidth/2;t={left:Math.min(t.left,Math.min(n.x1,n.x2)-s),right:Math.max(t.right,Math.max(n.x1,n.x2)+s),top:Math.min(t.top,Math.min(n.y1,n.y2)-s),bottom:Math.max(t.bottom,Math.max(n.y1,n.y2)+s)}}return t}function h(r,i){return i.map(t=>V(r,t)).filter(t=>t!==void 0).reduce((t,o)=>t===void 0?o:{left:Math.min(t.left,o.left),right:Math.max(t.right,o.right),top:Math.min(t.top,o.top),bottom:Math.max(t.bottom,o.bottom)},void 0)}function ee(r,i){const t=r.graphicSpec.objects[i];return(t.items?.[0]?.properties??t.properties).x}function w(r,i,t){const o=U(r,i);if(o.labelId===void 0||o.symbolIds.length===0)throw new Error(`Legend lane requires complete ${i} graphics.`);const e=[...o.symbolIds,o.labelId,...o.titleId===void 0?[]:[o.titleId]],n=h(r,e),s=["gradient","strokeGradient"].includes(i)&&t.representation!=="symbols"?[i==="gradient"?"colorGradientStrips":"strokeGradientStrips"]:o.symbolIds,c=h(r,s),f=h(r,o.symbolIds),p=G(r.graphicSpec,o.labelId,r.materializationConfigs.textMetrics),a=r.graphicSpec.objects[o.labelId].items?.length===0,d=o.titleId===void 0?void 0:(()=>{const l=r.graphicSpec.objects[o.titleId],u=G(r.graphicSpec,o.titleId,r.materializationConfigs.textMetrics);return{x:l.properties.x,y:l.properties.y,fontSize:l.properties.fontSize,width:u.right-u.left,bounds:u}})();if([n,c,f].includes(void 0)||p===void 0&&!a)throw new Error(`Legend lane could not measure ${i} graphics.`);return{id:i,kind:i,preserveGrid:(["series","color","stroke"].includes(i)||t.representation==="symbols")&&(t.columns??1)>1,target:t.target,border:C(i,t),offset:Q(t),bounds:n,title:d,symbol:{centerX:T(c.left,c.right),left:f.left,right:f.right,bounds:c},labels:{x:a?f.right+t.labels.offset:ee(r,o.labelId),width:a?0:p.right-p.left},occupiedBounds:h(r,[...e,...o.backgroundId===void 0?[]:[o.backgroundId]]),...o,foregroundIds:e}}function C(r,i){return["series","color","stroke","gradient","strokeGradient","opacity","interval","strokeInterval","strokeWidth","size"].includes(r)?i.border:!1}function B(r,i){const t=[];for(let o=0;o<r.length;o+=1){const e=r[o],n=i[e.kind],s=r[o+1];if(["series","color","stroke"].includes(e.kind)&&s?.kind==="size"&&s.target===e.target){t.push({id:`${e.kind}+size`,blocks:[e,s.backgroundId===void 0?s:{...s,bounds:s.occupiedBounds,inset:s.border.padding+s.border.lineWidth/2}],border:C(e.kind,n),backgroundId:e.backgroundId}),o+=1;continue}t.push({id:e.kind,blocks:[e],border:C(e.kind,n),backgroundId:e.backgroundId})}return t}function I(r,i){const t=r.guideConfigs.legend??{},o=new Map(r.semanticSpec.layers.map((e,n)=>[e.id,n]));return Object.entries(t).filter(([e,n])=>F(r,n.target)===void 0&&N(r,e,n)===i).sort(([e,n],[s,c])=>o.get(n.target)-o.get(c.target)||x[e]-x[s])}function te(r){return["right","left"].some(i=>I(r,i).length>0)}function ne(r){return["top","bottom"].some(i=>I(r,i).some(([,t])=>P({...t,position:i})))}function be(r){return te(r)||ne(r)}function oe(r,i,t){return r.map(o=>{if(o.op==="Z")return{...o};const e={...o,x:o.x+i,y:o.y+t};return o.op==="C"&&(e.x1=o.x1+i,e.y1=o.y1+t,e.x2=o.x2+i,e.y2=o.y2+t),e})}function H(r,i,t,o){const e={...i};return["circle","rect","text"].includes(r)?(e.x+=t,e.y+=o):r==="line"?(e.x1+=t,e.x2+=t,e.y1+=o,e.y2+=o):r==="path"&&(e.commands=oe(e.commands,t,o)),e}function b(r,i,t,o){const e=r.graphicSpec.objects[i];if(t===0&&o===0)return r;if(e.items!==void 0)return r.editGraphics({target:i,property:"items",value:e.items.map(c=>({type:c.type??e.type,properties:H(c.type??e.type,c.properties,t,o)}))});let n=r;const s=H(e.type,e.properties,t,o);for(const[c,f]of Object.entries(s))f!==e.properties[c]&&(n=n.editGraphics({target:i,property:c,value:f}));return n}function W(r,i){const t=e=>e.textBaseline==="middle"?{...e,y:e.y-e.fontSize/2,textBaseline:"top"}:e;let o=r;for(const e of i){const n=o.graphicSpec.objects[e];if(n.type==="text")if(n.items!==void 0){if(!n.items.some(s=>s.properties.textBaseline==="middle"))continue;o=o.editGraphics({target:e,property:"items",value:n.items.map(s=>({type:s.type??n.type,properties:t(s.properties)}))})}else n.properties.textBaseline==="middle"&&(o=o.editGraphics({target:e,property:"y",value:t(n.properties).y}).editGraphics({target:e,property:"textBaseline",value:"top"}))}return o}function A(r,i){return i.map(t=>{const o=t.blocks[0],e=r.guideConfigs.legend?.[o.kind],n=t.blocks.length>1,s=n?void 0:o.titleId,c=t.blocks.flatMap(l=>l.foregroundIds).filter(l=>l!==s);n&&c.push(...t.blocks.slice(1).flatMap(l=>l.backgroundId===void 0?[]:[l.backgroundId]));const f=h(r,c),p=h(r,[...c,...s===void 0?[]:[s]]);if(f===void 0||p===void 0)throw new Error(`Legend lane could not measure ${t.id} content.`);const a=t.border,d=a===!1?0:a.padding+a.lineWidth/2;return{id:t.id,atomic:n,titleId:s,contentIds:c,title:n?void 0:o.title,inline:e?.titlePosition==="left",element:n?p:o.symbol.bounds,content:f,horizontal:{left:p.left,right:p.right,top:p.top,bottom:p.bottom},inset:d,padding:a===!1?0:a.padding,backgroundId:t.backgroundId}})}function D(r,i,t){let o=r;const e=new Map(i.map(n=>[n.id,n]));for(const n of t.placements){const s=e.get(n.id);s.titleId!==void 0&&(o=b(o,s.titleId,n.dx,n.titleDy));for(const c of s.contentIds)o=b(o,c,n.dx,n.contentDy);if(n.background!==void 0)for(const c of["x","y","width","height"])o=o.editGraphics({target:n.background.id,property:c,value:n.background[c]})}if(t.background!==void 0)for(const n of["x","y","width","height"])o=o.editGraphics({target:t.background.id,property:n,value:t.background[n]});return o}const me=v({op:"rematerializeSideLegendLane",description:"Align and stack every right or left legend block."},function(r={}){z(r,"rematerializeSideLegendLane");const i=M(this),t=S(this)?.properties;if(i===void 0||t===void 0)throw new Error("Legend lane requires resolved Canvas and plot bounds.");const o=this.guideConfigs.legend??{},e=["right","left"].flatMap(s=>{const c=I(this,s);if(c.length===0)return[];if(c.length===1)return[{side:s,entries:c}];const f=c.map(([a,d])=>w(this,a,d));return[{plan:Y({side:s,plot:i,canvas:t,groups:B(f,o)}),blocks:f,side:s,entries:c}]});let n=this;for(const{plan:s,blocks:c,side:f,entries:p}of e){if(s===void 0)continue;const a=new Map(c.map(d=>[d.id,d]));for(const d of s.placements){const l=a.get(d.id);l.titleId!==void 0&&(n=b(n,l.titleId,d.titleDx,d.dy).editGraphics({target:l.titleId,property:"textAlign",value:"left"}));for(const u of l.symbolIds)n=b(n,u,d.symbolDx,d.dy);n=b(n,l.labelId,d.labelDx,d.dy).editGraphics({target:l.labelId,property:"textAlign",value:"left"})}for(const d of c){if(d.backgroundId===void 0||s.backgrounds.some(g=>g.id===d.backgroundId))continue;const l=h(n,d.foregroundIds),u=R([l],d.border,t,"Legend");n=$(n,d.backgroundId,u,d.border)}for(const d of s.backgrounds)for(const l of["x","y","width","height"])n=n.editGraphics({target:d.id,property:l,value:d[l]})}for(const{side:s,entries:c}of e){const f=c.flatMap(([d])=>m(n,d));n=W(n,f);const p=h(n,f),{dy:a}=Z({side:s,plot:i,canvas:t,bounds:p});for(const d of f)n=b(n,d,0,a)}return n}),ye=v({op:"rematerializeHorizontalLegendLane",description:"Pack and align every top or bottom legend block."},function(r={}){z(r,"rematerializeHorizontalLegendLane");const i=M(this),t=S(this)?.properties;if(i===void 0||t===void 0)throw new Error("Legend lane requires resolved Canvas and plot bounds.");const o=this.guideConfigs.legend??{};let e=this;for(const n of["top","bottom"]){const s=I(e,n).filter(([,a])=>P({...a,position:n})).map(([a,d])=>[a,E(e,a,d)]);if(s.length===0)continue;if(s.length===1){const[a,d]=s[0],l=m(e,a),u=O(e.graphicSpec,l,e.materializationConfigs.textMetrics),{dx:g,dy:y}=j({plot:i,canvas:t,config:{...d,offset:k(e,d,i)},bounds:u});for(const L of l)e=b(e,L,g,y);continue}for(const[a,d]of s){if(d.inferredOffset!==!0||k(e,d,i)===d.offset)continue;const l=m(e,a),u=O(e.graphicSpec,l,e.materializationConfigs.textMetrics),{dx:g,dy:y}=j({plot:i,canvas:t,config:{...d,offset:k(e,d,i)},bounds:u});for(const L of l)e=b(e,L,g,y)}let c=B(s.map(([a,d])=>w(e,a,d)),o);for(const a of c.filter(d=>d.blocks.length>1)){const d=o[a.blocks[0].kind],l=A(e,a.blocks.map((g,y)=>({id:g.id,blocks:[g],border:y===0?!1:g.border,backgroundId:y===0?void 0:g.backgroundId}))).map(g=>({...g,element:g.content})),u=X({edge:n,plot:i,canvas:t,groups:l,allowOverflow:e.materializationConfigs.canvas?.plot!==void 0,align:d.align,offset:k(e,d,i),border:a.border,backgroundId:a.backgroundId});e=D(e,l,u)}if(c.length<2)continue;c=B(s.map(([a,d])=>w(e,a,d)),o);const f=A(e,c),p=K({edge:n,plot:i,canvas:t,groups:f,allowOverflow:e.materializationConfigs.canvas?.plot!==void 0});e=D(e,f,p)}return e}),ke=v({op:"rematerializeLegendGroups",description:"Place each opted-in target legend group from occupied bounds."},function(r={}){z(r,"rematerializeLegendGroups");let i=this;const t=M(i),o=S(i)?.properties;for(const[e,n]of Object.entries(i.guideConfigs.legendGroups??{})){const s=Object.entries(i.guideConfigs.legend??{}).filter(([,a])=>a.target===e).sort(([a],[d])=>x[a]-x[d]);i=W(i,s.flatMap(([a])=>m(i,a)));const c=s.map(([a])=>({id:a,ids:m(i,a),bounds:h(i,m(i,a))})),f=n.placement.at!==void 0?n:{...n,placement:{...n.placement,offset:k(i,{...n.placement,inferredOffset:n.inferredOffset},t)}},p=q({blocks:c,group:f,plot:t,canvas:o,allowOverflow:i.materializationConfigs.canvas?.plot!==void 0});for(const a of p){const d=c.find(l=>l.id===a.id);for(const l of d.ids)i=b(i,l,a.dx,a.dy)}}return i});export{ne as hasHorizontalLegendLane,be as hasLegendLane,te as hasSideLegendLane,ye as rematerializeHorizontalLegendLane,ke as rematerializeLegendGroups,me as rematerializeSideLegendLane};

package/src/actions/guides/legends/remove.js

@@ -81,6 +81,9 @@ export const removeLegend = /* @__PURE__ */ closedAction(
     if (revision !== undefined) {
       next = createCategoricalLegendFromConfig(next, revision.config, revision.order);
     }
+    if (!Object.values(next.guideConfigs.legend ?? {}).some(config => config.target === target)) {
+      next = next._withoutMaterializationConfig(["guides", "legendGroups", target]);
+    }
     const retainedKinds = Object.keys(next.guideConfigs.legend ?? {});
     if (args.channels === undefined) {
       return retainedKinds.length === 0

package/src/actions/guides/legends/sampling.js

@@ -133,7 +133,7 @@ export function resolveLegendSampleValues(config, scale, label = "Legend") {
 }
 
 export function hasExactLegendSamplingForScale(program, scaleId) {
-  return ["size", "opacity", "strokeWidth"].some(kind => {
+  return ["size", "opacity", "strokeWidth", "gradient"].some(kind => {
     const config = program.guideConfigs.legend?.[kind];
     return config?.scale === scaleId && readLegendSampling(config).mode === "values";
   });