Class ActorSelector

constructor

• new ActorSelector(__namedParameters?, options): ActorSelector

• Parameters

  • __namedParameters: {
        actors: any;
        disableUnowned: undefined | boolean;
        filter: any;
        ownership: any;
        selected: undefined | null;
        showUnowned: undefined | boolean;
    } = {}

    • actors: any

    • disableUnowned: undefined | boolean

    • filter: any

    • ownership: any

    • selected: undefined | null

    • showUnowned: undefined | boolean

  • options: any

  Returns ActorSelector

actors

disableUnowned

filterFunc

ownership

search

selected

showUnowned

Static searchOptions

template

• get template(): string

• Returns string

title

• get title(): string

• Returns string

Static defaultOptions

• get defaultOptions(): {
      classes: string[];
      closeOnSubmit: boolean;
      height: string;
      resizable: boolean;
      scrollY: string[];
      submitOnChange: boolean;
      submitOnClose: boolean;
  }

• Returns {
      classes: string[];
      closeOnSubmit: boolean;
      height: string;
      resizable: boolean;
      scrollY: string[];
      submitOnChange: boolean;
      submitOnClose: boolean;
  }

  • classes: string[]

  • closeOnSubmit: boolean

  • height: string

  • resizable: boolean

  • scrollY: string[]

  • submitOnChange: boolean

  • submitOnClose: boolean

_clearSearch

• _clearSearch(event): void

• Parameters

  • event: any

  Returns void

_onSaveSelection

• _onSaveSelection(_event): void

• Parameters

  • _event: any

  Returns void

_searchFilterChange

• _searchFilterChange(event): void

• Update the search term and set a timeout to commit the search.

  Parameters

  • event: Event

    The triggering event

  Returns void

_searchFilterCommit

• _searchFilterCommit(event): void

• Process the search input and filter the actor list(s) on the fly.

  Parameters

  • event: Event

    The triggering event

  Returns void

_searchFilterCompositioning

• _searchFilterCompositioning(event): void

• Parameters

  • event: any

  Returns void

_updateObject

• _updateObject(_event, formData): void

• Parameters

  • _event: any

  • formData: any

  Returns void

activateListeners

• activateListeners(jq): void

• Parameters

  • jq: any

  Returns void

close

• close(...args): void

• Parameters

  • Rest ...args: any[]

  Returns void

getData

• getData(): {
      ownedActors: any;
      searchTerm: string;
      selected: string;
      showUnowned: boolean;
      unownedActors: any;
  }

• Returns {
      ownedActors: any;
      searchTerm: string;
      selected: string;
      showUnowned: boolean;
      unownedActors: any;
  }

  • ownedActors: any

  • searchTerm: string

  • selected: string

  • showUnowned: boolean

  • unownedActors: any

Static wait

• wait(options?, appOptions?, renderOptions?): Promise<null | string>

• Render actor selector and wait for it to resolve.

  Parameters

  • options: {
        actors: undefined | Actor[];
        disableUnowned: undefined | boolean;
        filter: Function;
        ownership: any;
        selected: undefined | string;
        showUnowned: undefined | boolean;
    } = {}

    Options

    • actors: undefined | Actor[]

      The actors list to choose from.

    • disableUnowned: undefined | boolean

      Disable interactions with unowned actors.

    • filter: Function

      Filter function

    • ownership: any

    • selected: undefined | string

      Already selected actor ID.

    • showUnowned: undefined | boolean

      Whether to show unowned actors.

  • Optional appOptions: object

    Application options

  • Optional renderOptions: object

    Render options

  Returns Promise<null | string>

  • Actor ID or null if cancelled.