Interface AnalyticsCategoryArtifact`Experimental`

Category / group-by distribution over one dimension field.

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

Hierarchy

AnalyticsArtifactBase
- AnalyticsCategoryArtifact

Index

Properties

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

Properties

`Readonly` `Experimental`contractVersion

contractVersion

`Readonly` `Experimental`dimension

dimension: string

Dimension field the marks group by.

`Optional` `Readonly` `Experimental`distinctCount

distinctCount?: number

Distinct categories the source reports, when more exist than were returned.

`Readonly` `Experimental`identity

identity: AnalyticsArtifactIdentity

`Readonly` `Experimental`kind

kind

`Readonly` `Experimental`marks

marks: readonly AnalyticsCategoryMark[]

`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?: null | number

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