Interface: MetricTileResult
Defined in: shared/insights/types/results.ts:98
A kind: "metric" tile's run: the live-compiled metric result.
Extends
Properties
dashboardKey
dashboardKey: string;Defined in: shared/insights/types/results.ts:90
Inherited from
kind
kind: "metric";Defined in: shared/insights/types/results.ts:99
metric
metric: MetricResult;Defined in: shared/insights/types/results.ts:100
ref
ref: string;Defined in: shared/insights/types/results.ts:93
Data-source key; a static text cell uses its tile id for stable matching.
Inherited from
tileId
tileId: string;Defined in: shared/insights/types/results.ts:91
Inherited from
visualization?
optional visualization?:
| {
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "metric";
legend?: boolean;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
ticker?: {
colorCoded?: boolean;
invertColors?: boolean;
label?: string;
value: string;
};
tickers?: {
colorCoded?: boolean;
invertColors?: boolean;
label?: string;
value: string;
}[];
value: string;
}
| {
category: string;
facet?: {
field: string;
scales?: "shared" | "independent";
};
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "bar";
legend?: boolean;
mode?: "percent" | "stacked" | "grouped" | "diverging";
orientation?: "vertical" | "horizontal";
series: {
colorSlot?: number;
field: string;
label?: string;
}[];
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
}
| {
bars: {
colorSlot?: number;
field: string;
label?: string;
}[];
curve?: "linear" | "monotone";
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "combo";
legend?: boolean;
lines: {
colorSlot?: number;
field: string;
label?: string;
}[];
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
x: string;
}
| {
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "gauge";
legend?: boolean;
limit?: number;
limitField?: string;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
sweep?: 180 | 270 | 360;
thresholds?: {
color: "success" | "warning" | "danger";
label?: string;
value: number;
}[];
value: string;
}
| {
area?: boolean;
compact?: boolean;
curve?: "linear" | "monotone";
facet?: {
field: string;
scales?: "shared" | "independent";
};
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "line";
legend?: boolean;
points?: boolean;
series: {
colorSlot?: number;
field: string;
label?: string;
}[];
stack?: "none" | "absolute" | "percent";
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
x: string;
}
| {
category: string;
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
innerRadiusRatio?: number;
kind: "pie";
legend?: boolean;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
value: string;
}
| {
facet?: {
field: string;
scales?: "shared" | "independent";
};
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
group?: string;
kind: "scatter";
label?: string;
legend?: boolean;
size?: string;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
x: string;
y: string;
}
| {
bins?: number;
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "histogram";
legend?: boolean;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
value: string;
}
| {
color?: "diverging" | "sequential";
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "heatmap";
legend?: boolean;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
value: string;
x: string;
y: string;
}
| {
after: string;
before: string;
category: string;
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "dumbbell";
legend?: boolean;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
}
| {
category: string;
change: string;
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "waterfall";
legend?: boolean;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
total?: string;
}
| {
conversion?: "previous" | "first";
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "funnel";
legend?: boolean;
stage: string;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
value: string;
}
| {
color?: "diverging" | "sequential";
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "us-map";
label?: string;
latitude: string;
legend?: boolean;
longitude: string;
state: string;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
value: string;
}
| {
color?: "diverging" | "sequential";
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "choropleth";
legend?: boolean;
region: string;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
value: string;
}
| {
kind: "table";
};Defined in: shared/insights/types/results.ts:94
Union Members
Type Literal
{
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "metric";
legend?: boolean;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
ticker?: {
colorCoded?: boolean;
invertColors?: boolean;
label?: string;
value: string;
};
tickers?: {
colorCoded?: boolean;
invertColors?: boolean;
label?: string;
value: string;
}[];
value: string;
}format?
optional format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};format.compact?
optional compact?: boolean;format.dateStyle?
optional dateStyle?: "short" | "long" | "medium";format.maximumFractionDigits?
optional maximumFractionDigits?: number;format.wholeNumberTicks?
optional wholeNumberTicks?: boolean;grid?
optional grid?: boolean;kind
kind: "metric";legend?
optional legend?: boolean;summary?
optional summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};summary.field
field: string = fieldKeySchema;summary.fn
fn: "min" | "max" | "count" | "avg" | "sum" | "last" = chartSummaryFnSchema;summary.label?
optional label?: string;ticker?
optional ticker?: {
colorCoded?: boolean;
invertColors?: boolean;
label?: string;
value: string;
};Deprecated
Prefer tickers; retained for backwards compatibility.
ticker.colorCoded?
optional colorCoded?: boolean;Set to false to keep this ticker neutral regardless of its sign.
ticker.invertColors?
optional invertColors?: boolean;ticker.label?
optional label?: string;ticker.value
value: string = fieldKeySchema;tickers?
optional tickers?: {
colorCoded?: boolean;
invertColors?: boolean;
label?: string;
value: string;
}[];value
value: string = fieldKeySchema;Type Literal
{
category: string;
facet?: {
field: string;
scales?: "shared" | "independent";
};
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "bar";
legend?: boolean;
mode?: "percent" | "stacked" | "grouped" | "diverging";
orientation?: "vertical" | "horizontal";
series: {
colorSlot?: number;
field: string;
label?: string;
}[];
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
}Type Literal
{
bars: {
colorSlot?: number;
field: string;
label?: string;
}[];
curve?: "linear" | "monotone";
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "combo";
legend?: boolean;
lines: {
colorSlot?: number;
field: string;
label?: string;
}[];
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
x: string;
}Type Literal
{
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "gauge";
legend?: boolean;
limit?: number;
limitField?: string;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
sweep?: 180 | 270 | 360;
thresholds?: {
color: "success" | "warning" | "danger";
label?: string;
value: number;
}[];
value: string;
}Type Literal
{
area?: boolean;
compact?: boolean;
curve?: "linear" | "monotone";
facet?: {
field: string;
scales?: "shared" | "independent";
};
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "line";
legend?: boolean;
points?: boolean;
series: {
colorSlot?: number;
field: string;
label?: string;
}[];
stack?: "none" | "absolute" | "percent";
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
x: string;
}Type Literal
{
category: string;
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
innerRadiusRatio?: number;
kind: "pie";
legend?: boolean;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
value: string;
}Type Literal
{
facet?: {
field: string;
scales?: "shared" | "independent";
};
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
group?: string;
kind: "scatter";
label?: string;
legend?: boolean;
size?: string;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
x: string;
y: string;
}Type Literal
{
bins?: number;
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "histogram";
legend?: boolean;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
value: string;
}Type Literal
{
color?: "diverging" | "sequential";
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "heatmap";
legend?: boolean;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
value: string;
x: string;
y: string;
}Type Literal
{
after: string;
before: string;
category: string;
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "dumbbell";
legend?: boolean;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
}Type Literal
{
category: string;
change: string;
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "waterfall";
legend?: boolean;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
total?: string;
}Type Literal
{
conversion?: "previous" | "first";
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "funnel";
legend?: boolean;
stage: string;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
value: string;
}Type Literal
{
color?: "diverging" | "sequential";
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "us-map";
label?: string;
latitude: string;
legend?: boolean;
longitude: string;
state: string;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
value: string;
}Type Literal
{
color?: "diverging" | "sequential";
format?: {
compact?: boolean;
dateStyle?: "short" | "long" | "medium";
maximumFractionDigits?: number;
wholeNumberTicks?: boolean;
};
grid?: boolean;
kind: "choropleth";
legend?: boolean;
region: string;
summary?: {
field: string;
fn: "min" | "max" | "count" | "avg" | "sum" | "last";
label?: string;
};
value: string;
}Type Literal
{
kind: "table";
}