Class Field

constructor

• new Field(dbField: string, name?: string): Field

  Creates an instance of Field.

  Parameters

  • dbField: string

    Name of the database column

  • Optionalname: string

    Name to use in the JSON output from Editor and the HTTP submit from the client-side when editing. If not given then the dbField name is used.

  Returns Field

StaticSetType

columnControl

• columnControl(): Options

  Get the options class for the options to get for ColumnControl

  Returns Options

• columnControl(options: Options): this

  Set the options class for the options to get for ColumnControl

  Parameters

  • options: Options

    Options configuration for ColumnControl

  Returns this

dbField

• dbField(): string

  Get the database column name

  Returns string

  Configured column name

• dbField(dbField: string): Field

  Set the database column name

  Parameters

  • dbField: string

    Column name to set

  Returns Field

  Self for chaining

get

• get(): boolean

  Get the get flag for the field (i.e. if the field should be read from the database).

  Returns boolean

  True if gettable, false otherwise.

• get(flag: boolean): Field

  Set the get flag.

  Parameters

  • flag: boolean

    true to mark as readable, false otherwise

  Returns Field

  Self for chaining

getFormatter

• getFormatter(): IFormatter

  Get formatter for the field's data.

  Returns IFormatter

  Formatter

• getFormatter(formatter: IFormatter): Field

  Set the get formatter.

  When the data has been retrieved from the server, it can be passed through a formatter here, which will manipulate (format) the data as required. This can be useful when, for example, working with dates and a particular format is required on the client-side.

  Parameters

  • formatter: IFormatter

    Formatter to use.

  Returns Field

  Self for chaining.

getValue

• getValue(): any

  Get the currently applied get value.

  Returns any

  Value - will be undefined by default.

• getValue(val: any): Field

  Set the get value for the field.

  If given, then this value is used to send to the client-side, regardless of what value is held by the database.

  Parameters

  • val: any

    Value to set

  Returns Field

  Self for chaining

http

• http(): boolean

  Indicator to say if this field can be read over http (i.e. externally)

  Returns boolean

• http(set: boolean): Field

  Set indicator to say if the field can be read via http

  Parameters

  • set: boolean

  Returns Field

name

• name(): string

  Get the field's configured name.

  Returns string

  Current name.

• name(name: string): Field

  Set the field's name.

  The name is typically the same as the dbField name, since it makes things less confusing(!), but it is possible to set a different name for the data which is used in the JSON returned to DataTables in a 'get' operation and the field name used in a 'set' operation.

  Parameters

  • name: string

    Name to set

  Returns Field

  Self for chaining

options

• options(): Options

  Get the currently configured options for the field.

  Returns Options

  Options object configured for this field

• options(opts: Options): Field

  Set an Options class instance for the options to get for this field

  Parameters

  • opts: Options

    Options instance

  Returns Field

  Self for chaining

• options(opts: CustomOptions): Field

  Set a custom option that will be used to get the options for this field

  Parameters

  • opts: CustomOptions

    Options instance

  Returns Field

  Self for chaining

• options(
      table: string,
      value: string,
      label: string,
      condition: any,
      format: IRenderer | null,
      order: string | boolean,
  ): Field

  Create an options instance based on the parameters passed in

  Parameters

  • table: string

    DB table name

  • value: string

    DB column name for the value field

  • label: string

    DB column name for the label field

  • condition: any

    SQL condition

  • format: IRenderer | null

    Formatting function to transform the text

  • order: string | boolean

    Order to apply

  Returns Field

  Self for chaining

searchBuilderOptions

• searchBuilderOptions(): SearchBuilderOptions | undefined

  Get the SearchBuilder options for this field if configured

  Returns SearchBuilderOptions | undefined

  SearchBuilder options

• searchBuilderOptions(sbOpts: SearchBuilderOptions): Field

  Set how a list iof options (values and labels) will be retrieved for the fields SearchBuilder.

  Parameters

  • sbOpts: SearchBuilderOptions

    SearchBuilderOptions

  Returns Field

  Self for chaining

searchPaneOptions

• searchPaneOptions(): SearchPaneOptions | undefined

  Get the SearchPanes options for this field if configured

  Returns SearchPaneOptions | undefined

  SearchPanes options

• searchPaneOptions(spOpts: SearchPaneOptions): Field

  Set how a list iof options (values and labels) will be retrieved for the fields SearchPanes.

  Parameters

  • spOpts: SearchPaneOptions

    SearchPanesOptions

  Returns Field

  Self for chaining

set

• set(): SetType

  Get the current set property for the field.

  Returns SetType

  Set configuration

• set(flag: boolean | SetType): Field

  Set the field's set configuration.

  A field can be marked as read only using this option, to be set only during an create or edit action or to be set during both actions. This provides the ability to have fields that are only set when a new row is created (for example a "created" time stamp).

  Parameters

  • flag: boolean | SetType

    Set flag.

  Returns Field

  Self for chaining.

setFormatter

• setFormatter(): IFormatter

  Set formatter for the field's data.

  Returns IFormatter

  Formatter

• setFormatter(formatter: IFormatter): Field

  Set the set formatter.

  When the data has been retrieved from the server, it can be passed through a formatter here, which will manipulate (format) the data as required. This can be useful when, for example, working with dates and a particular format is required on the client-side.

  Editor has a number of formatters available with the Format class which can be used directly with this method.

  Parameters

  • formatter: IFormatter

    Formatter to use.

  Returns Field

  Self for chaining.

setValue

• setValue(): any

  Get the currently applied set value.

  Returns any

  Value - will be undefined by default.

• setValue(val: any): Field

  Set the set value for the field.

  If given, then this value is used to write to the database regardless of what data is sent from the client-side.

  Parameters

  • val: any

    Value to set

  Returns Field

  Self for chaining

upload

• upload(): Upload

  Get the Upload class for this field.

  Returns Upload

  Configured upload class

• upload(upload: Upload): Field

  Set an Upload class for this field.

  Parameters

  • upload: Upload

    Upload class instance

  Returns Field

  Self for chaining

validator

• validator(): IValidator[]

  Get the validators applied to this field.

  Returns IValidator[]

  Array of validators

• validator(validator: IValidator, setFormatted?: boolean): Field

  Set the 'validator' of the field.

  The validator can be used to check if any abstract piece of data is valid or not according to the given rules of the validation function used.

  Multiple validation options can be applied to a field instance by calling this method multiple times. For example, it would be possible to have a 'required' validation and a 'maxLength' validation with multiple calls.

  Editor has a number of validation available with the Validator class which can be used directly with this method.

  Parameters

  • validator: IValidator

    Validator to add to the field

  • OptionalsetFormatted: boolean

  Returns Field

  Self for chaining

xss

• xss(): Ixss

  Get the current XSS formatter.

  Returns Ixss

  XSS formatter. Can be null or undefined.

• xss(flag: boolean | Ixss): Field

  Set a formatting method that will be used for XSS checking / removal. This should be a function that takes a single argument (the value to be cleaned) and returns the cleaned value.

  Editor will use xss-filters by default for this operation, which is built into the software and no additional configuration is required, but a custom function can be used if you wish to use a different formatter.

  If you wish to disable this option (which you would only do if you are absolutely confident that your validation will pick up on any XSS inputs) simply provide a closure function that returns the value given to the function. This is not recommended.

  Parameters

  • flag: boolean | Ixss

    Enable / disable XSS protection, or set a formatter.

  Returns Field

  Self for chaining.