Kaizen
Browse modulesInsightsinsights/sharedInterfaces

Interface: ResultColumn

Defined in: shared/insights/types/results.ts:22

A typed output column, carrying the format hints the client/export need.

Extended by

Properties

isAggregate?

optional isAggregate?: boolean;

Defined in: shared/insights/types/results.ts:37

true for an aggregate (a measure), false for a groupBy output (a dimension). The compiler knows this for every column; without it a client has to guess the category axis from type, which is wrong whenever a report groups by a numeric field (a year, a rating, a tier).

Optional only because hand-built fixtures predate it — every column produced by executeReport sets it.


key

key: string;

Defined in: shared/insights/types/results.ts:23


label

label: string;

Defined in: shared/insights/types/results.ts:24


money?

optional money?: {
  currencyCode?: string;
  representation: "decimal" | "minorUnits";
  scale: number;
};

Defined in: shared/insights/types/results.ts:27

Present iff type is money; drives currency/scale formatting.

currencyCode?

optional currencyCode?: string;

representation

representation: "decimal" | "minorUnits" = moneyRepresentationSchema;

scale

scale: number;

type

type: "string" | "number" | "boolean" | "date" | "enum" | "datetime" | "money";

Defined in: shared/insights/types/results.ts:25

On this page