Interface DataFieldOptions

interface DataFieldOptions {
    gmOnly?: boolean;
    hint?: string;
    initial?: any;
    label?: string;
    nullable?: boolean;
    required?: boolean;
    validate?: DataFieldValidator;
    validationError?: string;
}

Properties

gmOnly? hint? initial? label? nullable? required? validate? validationError?

Properties

OptionalgmOnly

gmOnly?: boolean

Can this field only be modified by a gamemaster or assistant gamemaster?

Optionalhint

hint?: string

Localizable help text displayed on forms which render this field.

Optionalinitial

initial?: any

The initial value of a field, or a function which assigns that initial value.

Optionallabel

label?: string

A localizable label displayed on forms which render this field.

Optionalnullable

nullable?: boolean

Can this field have null values?

Optionalrequired

required?: boolean

Is this field required to be populated?

Optionalvalidate

validate?: DataFieldValidator

A custom data field validation function.

OptionalvalidationError

validationError?: string

A custom validation error string. When displayed will be prepended with the document name, field name, and candidate value. This error string is only used when the return type of the validate function is a boolean. If an Error is thrown in the validate function, the string message of that Error is used.

Settings

Member Visibility

On This Page

Properties