docs: clarify that argmin and argmax expect field names (#7200)

Co-authored-by: GitHub Actions Bot <[email protected]>
vega · Jan 31, 2021 · 5032a8f · 5032a8f
1 parent c3edb93
commit 5032a8f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/build/vega-lite-schema.json b/build/vega-lite-schema.json
@@ -976,7 +976,7 @@
       "additionalProperties": false,
       "properties": {
         "argmax": {
-          "type": "string"
+          "$ref": "#/definitions/FieldName"
         }
       },
       "required": [
@@ -988,7 +988,7 @@
       "additionalProperties": false,
       "properties": {
         "argmin": {
-          "type": "string"
+          "$ref": "#/definitions/FieldName"
         }
       },
       "required": [

diff --git a/src/aggregate.ts b/src/aggregate.ts
@@ -1,5 +1,6 @@
 import {AggregateOp} from 'vega';
 import {isString, toSet} from 'vega-util';
+import {FieldName} from './channeldef';
 import {contains, Flag, keys} from './util';
 
 const AGGREGATE_OP_INDEX: Flag<AggregateOp> = {
@@ -35,11 +36,11 @@ export const MULTIDOMAIN_SORT_OP_INDEX = {
 };
 
 export interface ArgminDef {
-  argmin: string;
+  argmin: FieldName;
 }
 
 export interface ArgmaxDef {
-  argmax: string;
+  argmax: FieldName;
 }
 
 export type NonArgAggregateOp = Exclude<AggregateOp, 'argmin' | 'argmax'>;