Tidy 5e Sheets API
    Preparing search index...

    Type Alias TidyPartitionRegistry

    The organization schemes for Tidy's features. Each feature can have a different approach to partitioning. Partition data is designed to contain "keys" from the relevant Tidy feature. If the feature does not exist in the relevant Tidy feature area of config, the key will be ignored during processing.

    type TidyPartitionRegistry = {
        columns: {
            activity: ColumnPartitions;
            containerContents: ColumnPartitions;
            customItem: ColumnPartitions;
            effect: ColumnPartitions;
            encounterCombatant: ColumnPartitions;
            encounterMember: ColumnPartitions;
            feature: ColumnPartitions;
            groupMember: ColumnPartitions;
            inventory: ColumnPartitions;
            itemAdvancement: ColumnPartitions;
            spell: ColumnPartitions;
            vehicleAssignedCrew: ColumnPartitions;
            vehicleDraftAnimal: ColumnPartitions;
            vehiclePassenger: ColumnPartitions;
            vehicleUnassignedCrew: ColumnPartitions;
        };
        rowActions: {
            activity: string[];
            containerContents: string[];
            effect: string[];
            encounterCombatant: string[];
            encounterMember: string[];
            feature: string[];
            groupMember: string[];
            inventory: string[];
            itemAdvancement: string[];
            spell: string[];
            vehicleAssignedCrew: string[];
            vehicleDraftAnimal: string[];
            vehiclePassenger: string[];
            vehicleUnassignedCrew: string[];
        };
    }
    Index

    Properties

    Properties

    columns: {
        activity: ColumnPartitions;
        containerContents: ColumnPartitions;
        customItem: ColumnPartitions;
        effect: ColumnPartitions;
        encounterCombatant: ColumnPartitions;
        encounterMember: ColumnPartitions;
        feature: ColumnPartitions;
        groupMember: ColumnPartitions;
        inventory: ColumnPartitions;
        itemAdvancement: ColumnPartitions;
        spell: ColumnPartitions;
        vehicleAssignedCrew: ColumnPartitions;
        vehicleDraftAnimal: ColumnPartitions;
        vehiclePassenger: ColumnPartitions;
        vehicleUnassignedCrew: ColumnPartitions;
    }

    Partitions for Tidy Columns. Update these partitions at runtime to control sort order, visibility priority, and inclusion/exclusion at the full hierarchy of Foundry granularity: Document Name, Document Type, Tab ID, and Section Key.

    For each level, if no suitable partition is found, Tidy sometimes uses a default fallback partition, keyed as tidy5e-sheet-default

    Type Declaration

    • activity: ColumnPartitions

      Partitions for activity columns.

    • containerContents: ColumnPartitions

      Partitions for container contents columns.

    • customItem: ColumnPartitions

      Partitions for custom item columns.

    • effect: ColumnPartitions

      Partitions for effect columns.

    • encounterCombatant: ColumnPartitions

      Partitions for encounter combatant columns.

    • encounterMember: ColumnPartitions

      Partitions for encounter member columns.

    • feature: ColumnPartitions

      Partitions for feature columns.

    • groupMember: ColumnPartitions

      Partitions for group member columns.

    • inventory: ColumnPartitions

      Partitions for inventory (consumable, equipment, weapon, etc.) columns.

    • itemAdvancement: ColumnPartitions

      Partitions for item advancement columns.

    • spell: ColumnPartitions

      Partitions for spell columns.

    • vehicleAssignedCrew: ColumnPartitions

      Partitions for a vehicle's assigned crew columns.

    • vehicleDraftAnimal: ColumnPartitions

      Partitions for a vehicle's draft animal columns.

    • vehiclePassenger: ColumnPartitions

      Partitions for a vehicle's passenger columns.

    • vehicleUnassignedCrew: ColumnPartitions

      Partitions for a vehicle's unassigned crew columns.

    rowActions: {
        activity: string[];
        containerContents: string[];
        effect: string[];
        encounterCombatant: string[];
        encounterMember: string[];
        feature: string[];
        groupMember: string[];
        inventory: string[];
        itemAdvancement: string[];
        spell: string[];
        vehicleAssignedCrew: string[];
        vehicleDraftAnimal: string[];
        vehiclePassenger: string[];
        vehicleUnassignedCrew: string[];
    }

    Partitions for Tidy Row Actions. Update these partitions at runtime to control sort order and whether a row action will be included.

    • Order of keys denotes the order that the row actions will appear in the table.
    • Including or excluding a key controls whether the row action will be rendered at all. Excluded keys' row action condition callbacks are not even evaluated. They're just completely excluded.

    Type Declaration

    • activity: string[]

      Partitions for activity row actions.

    • containerContents: string[]

      Partitions for container contents row actions.

    • effect: string[]

      Partitions for effect row actions.

    • encounterCombatant: string[]

      Partitions for encounter combatant row actions.

    • encounterMember: string[]

      Partitions for encounter member row actions.

    • feature: string[]

      Partitions for feature row actions.

    • groupMember: string[]

      Partitions for group member row actions.

    • inventory: string[]

      Partitions for inventory (consumable, equipment, weapon, etc.) row actions.

    • itemAdvancement: string[]

      Partitions for item advancement row actions.

    • spell: string[]

      Partitions for spell row actions.

    • vehicleAssignedCrew: string[]

      Partitions for a vehicle's assigned crew row actions.

    • vehicleDraftAnimal: string[]

      Partitions for a vehicle's draft animal row actions.

    • vehiclePassenger: string[]

      Partitions for a vehicle's passenger row actions.

    • vehicleUnassignedCrew: string[]

      Partitions for a vehicle's unassigned crew row actions.