Class ItemSheetPF_Container

constructor

• new ItemSheetPF_Container(...args): ItemSheetPF_Container

• Parameters

  • Rest ...args: any[]

  Returns ItemSheetPF_Container

_filters

_itemUpdates

effectiveSearch

searchCompositioning

searchDelay

searchDelayEvent

searchRefresh

template

• get template(): string

• Return a dynamic reference to the HTML template path used to render this Item Sheet

  Returns string

Static defaultOptions

• get defaultOptions(): InsertKeys<{
      baseApplication: null | string;
      classes: string[];
      closeOnSubmit: boolean;
      dragDrop: ({
          dragSelector: string;
          dropSelector: string;
      } | {
          dragSelector: string;
          dropSelector?: undefined;
      })[];
      editable: boolean;
      filters: Omit<SearchFilterConfiguration, "callback">[];
      height: null | number | "auto";
      id: string;
      left: null | number;
      minimizable: boolean;
      popOut: boolean;
      resizable: boolean;
      scale: null | number;
      scrollY: string[];
      sheetConfig: boolean;
      submitOnChange: boolean;
      submitOnClose: boolean;
      tabs: {
          contentSelector: string;
          group: string;
          initial: string;
          navSelector: string;
      }[];
      template: null | string;
      title: string;
      top: null | number;
      viewPermission: 0 | 1 | 2 | 3;
      width: number;
  }, OmitByValue<{
      classes: string[];
      dragDrop: ({
          dragSelector: string;
          dropSelector: string;
      } | {
          dragSelector: string;
          dropSelector?: undefined;
      })[];
      scrollY: string[];
      width: number;
  }, never>>

• Returns InsertKeys<{
      baseApplication: null | string;
      classes: string[];
      closeOnSubmit: boolean;
      dragDrop: ({
          dragSelector: string;
          dropSelector: string;
      } | {
          dragSelector: string;
          dropSelector?: undefined;
      })[];
      editable: boolean;
      filters: Omit<SearchFilterConfiguration, "callback">[];
      height: null | number | "auto";
      id: string;
      left: null | number;
      minimizable: boolean;
      popOut: boolean;
      resizable: boolean;
      scale: null | number;
      scrollY: string[];
      sheetConfig: boolean;
      submitOnChange: boolean;
      submitOnClose: boolean;
      tabs: {
          contentSelector: string;
          group: string;
          initial: string;
          navSelector: string;
      }[];
      template: null | string;
      title: string;
      top: null | number;
      viewPermission: 0 | 1 | 2 | 3;
      width: number;
  }, OmitByValue<{
      classes: string[];
      dragDrop: ({
          dragSelector: string;
          dropSelector: string;
      } | {
          dragSelector: string;
          dropSelector?: undefined;
      })[];
      scrollY: string[];
      width: number;
  }, never>>

_applySectionFilter

• _applySectionFilter(item, section): boolean
• Internal

  Filters item by sheet section config.

  Parameters

  • item: Item

    Item to filter

  • section: object

    Section to filter by

  Returns boolean

_clearSearch

• _clearSearch(event): void

• Parameters

  • event: any

  Returns void

_convertCurrency

• _convertCurrency(event): void

• Parameters

  • event: any

  Returns void

_duplicateItem

• _duplicateItem(event): Promise<any>

• Parameters

  • event: any

  Returns Promise<any>

_mouseWheelAdd

• _mouseWheelAdd(event, el): void

• Parameters

  • event: any

  • el: any

  Returns void

_onDragStart

• _onDragStart(event): void
• Internal

  Parameters

  • event: any

  Returns void

_onDrop

• _onDrop(event): undefined | Promise<any>
• Internal

  Parameters

  • event: any

  Returns undefined | Promise<any>

_onDropCurrency

• _onDropCurrency(event, data): Promise<unknown>

• Parameters

  • event: any

  • data: any

  Returns Promise<unknown>

_onDropItem

• _onDropItem(event, data): Promise<any>

• Parameters

  • event: any

  • data: any

  Returns Promise<any>

_onItemCreate

• _onItemCreate(event): any

• Parameters

  • event: any

  Returns any

_onItemDelete

• _onItemDelete(event): void

• Parameters

  • event: any

  Returns void

_onItemEdit

• _onItemEdit(event): void

• Parameters

  • event: any

  Returns void

_onItemSummary

• _onItemSummary(event): void

• Parameters

  • event: any

  Returns void

_onItemTake

• _onItemTake(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onSortItem

• _onSortItem(event, itemData): any

• Parameters

  • event: any

  • itemData: any

  Returns any

_openItemSummary

• _openItemSummary(elem, options?): Promise<void>
• Internal

  Parameters

  • elem: Element

  • Optional options: {
        animation: undefined | boolean;
        rollData: undefined | object;
    } = {}

    Additional options

    • animation: undefined | boolean

    • rollData: undefined | object

  Returns Promise<void>

_prepareContents

• _prepareContents(context): void

• Parameters

  • context: any

  Returns void

_quickChangeItemQuantity

• _quickChangeItemQuantity(event, add?): Promise<any>

• Parameters

  • event: any

  • add: number = 1

  Returns Promise<any>

_quickIdentifyItem

• _quickIdentifyItem(event): Promise<any>

• Parameters

  • event: any

  Returns Promise<any>

_renderInner

• _renderInner(...args): Promise<JQuery<HTMLElement>>

• Parameters

  • Rest ...args: any[]

  Returns Promise<JQuery<HTMLElement>>

_searchFilterChange

• _searchFilterChange(event): void

• Parameters

  • event: any

  Returns void

_searchFilterCommit

• _searchFilterCommit(event): void

• Item Search

  Parameters

  • event: any

  Returns void

_searchFilterCompositioning

• _searchFilterCompositioning(event): void

• Parameters

  • event: any

  Returns void

_setItemUses

• _setItemUses(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_updateItems

• _updateItems(): Promise<any[]>

• Returns Promise<any[]>

activateListeners

• activateListeners(html): void

• Activate listeners for interactive item sheet events

  Parameters

  • html: any

  Returns void

getData

• getData(): Promise<{
      canClassLink: boolean;
      config: config;
      document: ItemPF;
      editable: boolean;
      inContainer: boolean;
      isGM: boolean;
      item: ItemPF;
      itemType: string;
      labels: Record<string, string>;
      name: null | string;
      owned: boolean;
      owner: boolean;
      rollData: object;
      system: any;
      tag: any;
  }>

• Prepare item sheet data Start with the base item data and extending with additional properties for rendering.

  Returns Promise<{
      canClassLink: boolean;
      config: config;
      document: ItemPF;
      editable: boolean;
      inContainer: boolean;
      isGM: boolean;
      item: ItemPF;
      itemType: string;
      labels: Record<string, string>;
      name: null | string;
      owned: boolean;
      owner: boolean;
      rollData: object;
      system: any;
      tag: any;
  }>

setItemUpdate

• setItemUpdate(id, key, value): void

• Parameters

  • id: any

  • key: any

  • value: any

  Returns void