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

    Interface YearPlannerHandle

    Imperative handle exposed by YearPlanner.

    interface YearPlannerHandle {
        clearSelection(): void;
        focusDate(date: string): void;
        focusItem(id: string): void;
        getEffectiveVisibility(
            id: string,
        ): {
            reason:
                | "visible"
                | "item"
                | "filter"
                | "group"
                | "layer"
                | "channel"
                | "unknown-entity";
            visible: boolean;
        };
        hideGroup(id: string): void;
        hideItem(id: string): void;
        hideLayer(id: string): void;
        openInspector(): void;
        requestCommand(command: PlannerCommand): void;
        requestRedo(): void;
        requestUndo(): void;
        scrollToDate(date: string): void;
        selectRange(
            interval: { endDateExclusive: string; startDate: string },
        ): void;
        setFilter(filter: PlannerFilter): void;
        setInteractionMode(mode: InteractionMode): void;
        showAll(): void;
        showGroup(id: string): void;
        showItem(id: string): void;
        showLayer(id: string): void;
        toggleGroup(id: string): void;
    }
    Index
    • Moves focus to a date cell.

      Parameters

      • date: string

      Returns void

    • Moves focus to an item proxy.

      Parameters

      • id: string

      Returns void

    • Resolves the effective visibility of an item.

      Parameters

      • id: string

      Returns {
          reason:
              | "visible"
              | "item"
              | "filter"
              | "group"
              | "layer"
              | "channel"
              | "unknown-entity";
          visible: boolean;
      }

      • reason: "visible" | "item" | "filter" | "group" | "layer" | "channel" | "unknown-entity"

        Rule that decided the visibility.

      • visible: boolean

        Whether the item is effectively visible.

    • Hides a group and its descendants.

      Parameters

      • id: string

      Returns void

    • Hides an item.

      Parameters

      • id: string

      Returns void

    • Hides a layer.

      Parameters

      • id: string

      Returns void

    • Routes a command through the command pipeline.

      Parameters

      • command: PlannerCommand

      Returns void

    • Reapplies the last undone local change; controlled item lists delegate redo to the host.

      Returns void

    • Reverts the last local change; controlled item lists delegate undo to the host.

      Returns void

    • Scrolls a date into view.

      Parameters

      • date: string

      Returns void

    • Selects a date range.

      Parameters

      • interval: { endDateExclusive: string; startDate: string }

      Returns void

    • Replaces the filter.

      Parameters

      • filter: PlannerFilter

      Returns void

    • Changes the interaction mode.

      Parameters

      • mode: InteractionMode

      Returns void

    • Shows every group, layer and item; hidden render channels stay hidden.

      Returns void

    • Shows a group.

      Parameters

      • id: string

      Returns void

    • Shows an item.

      Parameters

      • id: string

      Returns void

    • Shows a layer.

      Parameters

      • id: string

      Returns void

    • Toggles a group.

      Parameters

      • id: string

      Returns void