Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

3.2 KB
Raw Blame
/* Copyright 2026 Marimo. All rights reserved. */
import { Marks } from "./marks";
import { ParamNames } from "./params";
import type {
  AnyMark,
  Encodings,
  EncodingType,
  Field,
  MarkDef,
  SharedCompositeEncoding,
  VegaLiteSpec,
} from "./types";

/**
 * Vega has multiple types of encodings: x, y, color, size, etc.
 *
 * For all the non-xy encodings, we want to find all the fields that are encoded.
 * These are the encodings that are placed on the legend and thus selectable.
 */
export function findEncodedFields(spec: VegaLiteSpec): string[] {
  if (!spec || !("encoding" in spec)) {
    return [];
  }

  const { encoding } = spec;
  if (!encoding) {
    return [];
  }

  const encodings = Object.entries(encoding);

  // We need to find the field from:
  // "color": {
  //   "condition": {
  //     "field": "?",
  //     "type": "nominal",
  //     "test": {"and": [{"param": "select"}]}
  //   },
  //   "value": "grey"
  // },
  // OR
  // "size": {"field": "?", "type": "quantitative"},

  return encodings.flatMap((entry) => {
    const [key, encoding] = entry as [keyof Encodings, Encodings];
    if (!encoding) {
      return [];
    }
    if (!ALLOWED_ENCODING_TYPES.has(key)) {
      return [];
    }

    if ("field" in encoding && typeof encoding.field === "string") {
      return [encoding.field];
    }

    if (
      "condition" in encoding &&
      encoding.condition &&
      typeof encoding.condition === "object" &&
      "field" in encoding.condition &&
      encoding.condition.field &&
      typeof encoding.condition.field === "string"
    ) {
      return [encoding.condition.field];
    }

    return [];
  });
}

// We can add more encodings here if we want to support more
const ALLOWED_ENCODING_TYPES = new Set<EncodingType>([
  "color",
  "fill",
  "fillOpacity",
  "opacity",
  "shape",
  "size",
]);

export function makeEncodingInteractive(
  key: "opacity",
  encodings: SharedCompositeEncoding<Field>,
  paramNames: string[],
  mark: AnyMark | undefined,
): SharedCompositeEncoding<Field> {
  // For binned charts, we only use the bin_coloring param for opacity.
  // The regular selection params (point/interval) are used for backend filtering only.
  // This separation allows us to control which params trigger visual feedback vs data filtering.
  // NOTE: Bin + interval selection does not change the opacity at all.
  const opacityParams = paramNames.filter((paramName) =>
    ParamNames.isBinColoring(paramName),
  );

  // If we have bin_coloring params, use only those for opacity.
  // Otherwise, use all params (non-binned chart behavior).
  const relevantParams = opacityParams.length > 0 ? opacityParams : paramNames;

  // Use AND so all conditions must be met
  const test = {
    and: relevantParams.map((paramName) => ({
      param: paramName,
    })),
  };

  switch (key) {
    // As of now, we only update opacity to signal selection
    case "opacity": {
      const initialOpacity = Marks.getOpacity(mark as MarkDef) || 1;
      return {
        ...encodings,
        opacity: {
          condition: {
            test: test,
            value: initialOpacity,
          },
          value: initialOpacity / 5, // 20% opacity
        },
      };
    }
    default:
      return encodings;
  }
}