@honua/sdk-js
    Preparing search index...

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

    Hierarchy

    • AnalyticsArtifactBase
      • AnalyticsHistogramArtifact
    Index

    Properties

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

    Properties

    bins: number

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

    contractVersion: "1.0"
    dimension: string
    domain?: { max: number; min: number }

    Inclusive numeric domain the bins cover.

    identity: AnalyticsArtifactIdentity
    kind: "histogram"
    marks: readonly AnalyticsHistogramMark[]
    measure: AnalyticsMeasure
    message?: string

    Required when status is unsupported or error.

    nullPolicy: AnalyticsNullPolicy
    ordering: AnalyticsOrdering
    provenance: AnalyticsProvenance
    status: AnalyticsArtifactStatus
    title?: string
    total?: number | null

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

    Settings

    Member Visibility

    On This Page

    Properties