Interface AnalyticsTimeSeriesArtifact`Experimental`

Bucketed series over one temporal field.

interface AnalyticsTimeSeriesArtifact {
    contractVersion: "1.0";
    dimension: string;
    identity: AnalyticsArtifactIdentity;
    interval: AggregationTimeIntervalSpec;
    kind: "time-series";
    marks: readonly AnalyticsTimeSeriesMark[];
    measure: AnalyticsMeasure;
    message?: string;
    nullPolicy: AnalyticsNullPolicy;
    ordering: AnalyticsOrdering;
    provenance: AnalyticsProvenance;
    status: AnalyticsArtifactStatus;
    title?: string;
    total?: number | null;
    window?: AnalyticsTemporalWindow;
}

Hierarchy

AnalyticsArtifactBase
- AnalyticsTimeSeriesArtifact

Index

Properties

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

Properties

`Readonly` `Experimental`contractVersion

contractVersion: "1.0"

`Readonly` `Experimental`dimension

dimension: string

`Readonly` `Experimental`identity

identity: AnalyticsArtifactIdentity

`Readonly` `Experimental`interval

interval: AggregationTimeIntervalSpec

`Readonly` `Experimental`kind

kind: "time-series"

`Readonly` `Experimental`marks

marks: readonly AnalyticsTimeSeriesMark[]

`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).

`Optional` `Readonly` `Experimental`window

window?: AnalyticsTemporalWindow

Half-open temporal domain the series covers.