EntitySheetConfig

EntitySheetConfig

Entity Sheet Configuration Application

Constructor

new EntitySheetConfig(entity, options)

Source:
Parameters:
Name Type Description
entity Entity

The Entity object for which the sheet is being configured
options Object

Additional Application options

Members

title :string

Source:

Add the Entity name into the window title

Type:
  • string

Methods

(static) initializeSheets()

Source:

Initialize the configured Sheet preferences for Entities which support dynamic Sheet assignment Create the configuration structure for supported entities Process any pending sheet registrations Update the default values from settings data

(static) registerSheet(entityClass, scope, sheetClass, options)

Source:

Register a sheet class as a candidate which can be used to display entities of a given type

Parameters:
Name Type Description
entityClass Entity

The Entity for which to register a new Sheet option
scope string

Provide a unique namespace scope for this sheet
sheetClass Application

A defined Application class used to render the sheet
options Object

Additional options used for sheet registration

Properties
Name Type Attributes Description
label string <optional>

A human readable label for the sheet name, which will be localized
types Array.<string> <optional>

An array of entity types for which this sheet should be used
makeDefault boolean <optional>

Whether to make this sheet the default for provided types

(static) unregisterSheet(entityClass, scope, sheetClass, types)

Source:

Unregister a sheet class, removing it from the list of available Applications to use for an Entity type

Parameters:
Name Type Description
entityClass Entity

The Entity for which to register a new Sheet option
scope string

Provide a unique namespace scope for this sheet
sheetClass Application

A defined Application class used to render the sheet
types Array.<object>

An Array of types for which this sheet should be removed

getData() → {Object}

Source:

Construct and return the data object used to render the HTML template for this form application.

Returns:
Type
Object