[graphology-canvas] render() ignores everything in settings argument except for width and height #542

thSoft · 2025-04-25T23:31:58Z

render calls refineSettings which looks like this:

exports.refineSettings = function refineSettings(settings) {
  settings = settings || {};

  var dimensions = {
    width: settings.width,
    height: settings.height
  };

  if (dimensions.width && !dimensions.height)
    dimensions.height = dimensions.width;

  if (dimensions.height && !dimensions.width)
    dimensions.width = dimensions.height;

  settings = resolveDefaults(settings, dimensions);
  settings = resolveDefaults(settings, DEFAULTS);

  if (!settings.width && !settings.height)
    throw new Error(
      'graphology-canvas: need at least a valid width or height!'
    );

  return settings;
};

Before executing the settings = resolveDefaults(settings, dimensions); line, the value of the settings argument is:

{
  width: 300,
  height: 200,
  nodes: {
    defaultColor: "#0000ff",
    reducer: (_, node)=>{
      const attributes = graph.getNodeAttributes(node);
      const position = nodePositions.get(node);
      const attributeStrings = Object.entries(attributes).filter(([_, value])=>value !== undefined && value !== null).map(([key, value])=>`${key}: ${JSON.stringify(value)}`).join("\n");
      return {
          x: position?.x ?? 0,
          y: position?.y ?? 0,
          size: 20,
          label: `${characters[node]?.name || node}\n${attributeStrings}`,
          color: attributes.dead ? "#ff0000" : "#0000ff"
      };
    },
  },
  edges: {
    defaultColor: "#000000",
  },
}

After executing it, it becomes:

{
  width: 300,
  height: 200,
}

The text was updated successfully, but these errors were encountered:

Yomguithereal · 2025-04-28T11:04:23Z

Reading the way the resolveDefaults function works, it seems you are right indeed. DEFAULTS resolution should happen before using the dimensions to merge. This could should be refactored to avoid the problem you demonstrate. Do you want to contribute a fix?

Yomguithereal added the bug label Apr 28, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[graphology-canvas] render() ignores everything in settings argument except for width and height #542

[graphology-canvas] render() ignores everything in settings argument except for width and height #542

[graphology-canvas] render() ignores everything in settings argument except for width and height #542

[graphology-canvas] render() ignores everything in settings argument except for width and height #542

Comments