Interface AnalyticsAggregateArtifact`Experimental`

One or more scalar aggregates with no dimension.

interface AnalyticsAggregateArtifact {
    contractVersion: "1.0";
    identity: AnalyticsArtifactIdentity;
    kind: "aggregate";
    marks: readonly AnalyticsAggregateMark[];
    measure: AnalyticsMeasure;
    message?: string;
    nullPolicy: AnalyticsNullPolicy;
    ordering: AnalyticsOrdering;
    provenance: AnalyticsProvenance;
    status: AnalyticsArtifactStatus;
    title?: string;
    total?: number | null;
}

Hierarchy

AnalyticsArtifactBase
- AnalyticsAggregateArtifact

Index

Properties

contractVersion identity kind marks measure message? nullPolicy ordering provenance status title? total?

Properties

`Readonly` `Experimental`contractVersion

contractVersion: "1.0"

`Readonly` `Experimental`identity

identity: AnalyticsArtifactIdentity

`Readonly` `Experimental`kind

kind: "aggregate"

`Readonly` `Experimental`marks

marks: readonly AnalyticsAggregateMark[]

`Readonly` `Experimental`measure

measure: AnalyticsMeasure

`Optional` `Readonly` `Experimental`message

message?: string

Required when status is unsupported or error.

`Readonly` `Experimental`nullPolicy

nullPolicy: AnalyticsNullPolicy

`Readonly` `Experimental`ordering

ordering: AnalyticsOrdering

`Readonly` `Experimental`provenance

provenance: AnalyticsProvenance

`Readonly` `Experimental`status

status: AnalyticsArtifactStatus

`Optional` `Readonly` `Experimental`title

title?: string

`Optional` `Readonly` `Experimental`total

total?: number | null

Total across all marks when the producer knows it (may exceed the sum).