IFClite TypeScript API
    Preparing search index...

    Interface IdsReportBlock

    A frozen snapshot of an IDS / information-validation report (#5125, #6372), taken from the live ValidationReport when the block is added or refreshed — like a table block's list copy, it travels with the document instead of reading the store, so a saved document still prints the run that produced it.

    interface IdsReportBlock {
        automation?: AutomationReportProvenance;
        benchmarks?: boolean;
        checks: IdsReportCheckSummary[];
        elementEvidence?: SavedValidationElements;
        generatedAt: string;
        id: string;
        kind: "ids-report";
        reportModels?: ReportModelScope[];
        savedReportId?: string;
        scale?: number;
        showStamp?: boolean;
        sourceKind?: ReportSourceKind;
        sourceName: string;
        specificationsOnly?: boolean;
        summary: {
            checked: number;
            failed: number;
            passed: number;
            passRate: number;
            warnings?: number;
        };
        title?: string;
        titleBackgroundColor?: string;
        titleFontSize?: number;
        titleTextColor?: string;
        variant?: IdsReportVariant;
    }

    Hierarchy (View Summary)

    Index
    automation? benchmarks? checks elementEvidence? generatedAt id kind reportModels? savedReportId? scale? showStamp? sourceKind? sourceName specificationsOnly? summary title? titleBackgroundColor? titleFontSize? titleTextColor? variant?
    automation?: AutomationReportProvenance

    Captured workflow execution identity; travels with the evidence, never a live binding.

    benchmarks?: boolean

    Optional ring benchmark (#6552). Absent retains existing document output.

    checks: IdsReportCheckSummary[]
    elementEvidence?: SavedValidationElements

    Optional immutable element failures; absent in older count-only snapshots (#7091).

    generatedAt: string

    When the snapshotted run finished (ValidationReport.timestamp, ISO).

    id: string
    kind: "ids-report"
    reportModels?: ReportModelScope[]
    savedReportId?: string
    scale?: number

    Whole-block size, 0.5-2 (#6548); absent is 1.

    showStamp?: boolean
    sourceKind?: ReportSourceKind

    Which engine produced the snapshot (#6372). Absent means 'ids': every block saved before this field existed was labelled IDS.

    sourceName: string

    IDS document title, or rule-set name, printed in the block's heading.

    specificationsOnly?: boolean

    Compact layout only (#6560): print one bar row per specification and leave out its requirement rows. Optional and additive, so the document format version is unchanged; a viewer that supports the document format but predates this field ignores it and prints the full compact report.

    summary: {
        checked: number;
        failed: number;
        passed: number;
        passRate: number;
        warnings?: number;
    }

    failed excludes warning-severity failures, which warnings counts (#6372; absent on IDS snapshots).

    title?: string
    titleBackgroundColor?: string

    Heading strip background in #RRGGBB; absent is transparent paper.

    titleFontSize?: number

    Heading text size, BLOCK_TITLE_SIZE_MIN-BLOCK_TITLE_SIZE_MAX points.

    titleTextColor?: string

    Heading ink in #RRGGBB; absent is black, or black/white by contrast when a background is set.

    variant?: IdsReportVariant

    Layout (#6470). Absent in documents saved before it existed, which keep printing the original layout (one truncated line per field) until the author picks one.

    Settings
    Member Visibility

    On This Page
    Properties