@blendsdk/year-planner-core
    Preparing search index...

    Interface ClassicYearLayoutOptions

    Options for building a classic year layout.

    interface ClassicYearLayoutOptions {
        contextMonths?: { after: number; before: number };
        highlightYear?: number;
        range?: { monthCount: number; start: { month: number; year: number } };
        units?: Partial<ClassicYearUnits>;
        year?: number;
    }
    Index
    contextMonths?: { after: number; before: number }

    Context months before and after the year; defaults to one on each side.

    Type Declaration

    • after: number

      Context months after the year; defaults to 1.

    • before: number

      Context months before the year; defaults to 1.

    highlightYear?: number

    Year marked as current; changes emphasis only.

    range?: { monthCount: number; start: { month: number; year: number } }

    Explicit window; wins over the year.

    Type Declaration

    • monthCount: number

      Number of months in the window; 12-36.

    • start: { month: number; year: number }

      First month of the explicit window.

      • month: number

        Zero-based month index (0 = January).

      • year: number

        Calendar year of the first month.

    units?: Partial<ClassicYearUnits>

    Layout overrides; wins over theme geometry.

    year?: number

    Year to render when no explicit range is supplied.