vega-lite/src/compile/mark/encode/defined.ts

Vega-Lite is a concise high-level language for interactive visualization.

import {isCountingAggregateOp} from '../../../aggregate.js';
import {isScaleChannel} from '../../../channel.js';
import {Value} from '../../../channeldef.js';
import {fieldValidPredicate} from '../../../predicate.js';
import {VgEncodeEntry} from '../../../vega.schema.js';
import {signalOrValueRef} from '../../common.js';
import {getScaleInvalidDataMode, shouldBreakPath} from '../../invalid/ScaleInvalidDataMode.js';
import {UnitModel} from '../../unit.js';

/**
 * Create Vega's "defined" encoding to break paths in a path mark for invalid values.
 */
export function defined(model: UnitModel): VgEncodeEntry {
  const {config, markDef} = model;

  // For each channel (x/y), add fields to break path to a set first.
  const fieldsToBreakPath = new Set<string>();

  model.forEachFieldDef((fieldDef, channel) => {
    let scaleType;
    if (!isScaleChannel(channel) || !(scaleType = model.getScaleType(channel))) {
      // Skip if the channel is not a scale channel or does not have a scale
      return;
    }

    const isCountAggregate = isCountingAggregateOp(fieldDef.aggregate);
    const invalidDataMode = getScaleInvalidDataMode({
      scaleChannel: channel,
      markDef,
      config,
      scaleType,
      isCountAggregate,
    });
    if (shouldBreakPath(invalidDataMode)) {
      const field = model.vgField(channel, {expr: 'datum', binSuffix: model.stack?.impute ? 'mid' : undefined});
      if (field) {
        fieldsToBreakPath.add(field);
      }
    }
  });

  // If the set is not empty, return a defined signal.
  if (fieldsToBreakPath.size > 0) {
    const signal = [...fieldsToBreakPath].map((field) => fieldValidPredicate(field, true)).join(' && ');
    return {defined: {signal}};
  }
  return undefined;
}

export function valueIfDefined(prop: string, value: Value): VgEncodeEntry {
  if (value !== undefined) {
    return {[prop]: signalOrValueRef(value)};
  }
  return undefined;
}