Interface AnalyticsHistogramArtifactExperimental

Binned distribution over one numeric field.

interface AnalyticsHistogramArtifact {
    bins: number;
    contractVersion: "1.0";
    dimension: string;
    domain?: {
        max: number;
        min: number;
    };
    identity: AnalyticsArtifactIdentity;
    kind: "histogram";
    marks: readonly AnalyticsHistogramMark[];
    measure: AnalyticsMeasure;
    message?: string;
    nullPolicy: AnalyticsNullPolicy;
    ordering: AnalyticsOrdering;
    provenance: AnalyticsProvenance;
    status: AnalyticsArtifactStatus;
    title?: string;
    total?: null | number;
}

Hierarchy

  • AnalyticsArtifactBase
    • AnalyticsHistogramArtifact

Properties

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

Properties

Readonly Experimentalbins

bins: number

Requested bin count. marks.length may be smaller for sparse results.

Readonly ExperimentalcontractVersion

contractVersion

Readonly Experimentaldimension

dimension: string

Optional Readonly Experimentaldomain

domain?: {
    max: number;
    min: number;
}

Inclusive numeric domain the bins cover.

Readonly Experimentalidentity

identity: AnalyticsArtifactIdentity

Readonly Experimentalkind

kind

Readonly Experimentalmarks

marks: readonly AnalyticsHistogramMark[]

Readonly Experimentalmeasure

measure: AnalyticsMeasure

Optional Readonly Experimentalmessage

message?: string

Required when status is unsupported or error.

Readonly ExperimentalnullPolicy

nullPolicy: AnalyticsNullPolicy

Readonly Experimentalordering

ordering: AnalyticsOrdering

Readonly Experimentalprovenance

provenance: AnalyticsProvenance

Readonly Experimentalstatus

status: AnalyticsArtifactStatus

Optional Readonly Experimentaltitle

title?: string

Optional Readonly Experimentaltotal

total?: null | number

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

Settings

Member Visibility

On This Page

Properties