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

    Interface AnalyticsCategoryArtifactExperimental

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

    Hierarchy

    • AnalyticsArtifactBase
      • AnalyticsCategoryArtifact
    Index

    Properties

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

    Properties

    contractVersion: "1.0"
    dimension: string

    Dimension field the marks group by.

    distinctCount?: number

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

    identity: AnalyticsArtifactIdentity
    kind: "category"
    marks: readonly AnalyticsCategoryMark[]
    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