Class Column

Index

Constructors

Methods

columnControl dbField getFormatter getValue name searchBuilderOptions searchPaneOptions

Constructors

constructor

new Column(dbField: string, name?: string): Column
Create a new column
Parameters
- dbField: string
  Name of the database column
- Optionalname: string
  Name to use in the JSON output. If not given then the dbField name is used.
Returns Column
- Defined in column.ts:18

Methods

columnControl

columnControl(): Options
Get the options class for the options to get for ColumnControl

Returns Options
- Defined in column.ts:30
columnControl(options: Options): this
Set the options class for the options to get for ColumnControl
Parameters
- options: Options
  Options configuration for ColumnControl
Returns this
- Defined in column.ts:36

dbField

dbField(): string
Get the database column name

Returns string
Configured column name
- Defined in column.ts:46
dbField(name: string): Column
Set the database column name
Parameters
- name: string
  Column name to set
Returns Column
Self for chaining
- Defined in column.ts:53

getFormatter

getFormatter(): IFormatter
Get formatter for the field's data.

Returns IFormatter
Formatter
- Defined in column.ts:73
getFormatter(formatter: IFormatter): Column
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 Column
Self for chaining.
- Defined in column.ts:85

getValue

getValue(): any
Get the currently applied get value.

Returns any
Value - will be undefined by default.
- Defined in column.ts:95
getValue(val: any): Column
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 Column
Self for chaining
- Defined in column.ts:105

name

name(): string
Get the column's configured name.

Returns string
Current name.
- Defined in column.ts:115
name(name: string): Column
Set the column'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.
Parameters
- name: string
  Name to set
Returns Column
Self for chaining
- Defined in column.ts:126

searchBuilderOptions

searchBuilderOptions(): SearchBuilderOptions | undefined
Get the SearchBuilder options for this field if configured

Returns SearchBuilderOptions | undefined
SearchBuilder options
- Defined in column.ts:136
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
- Defined in column.ts:145

searchPaneOptions

searchPaneOptions(): SearchPaneOptions | undefined
Get the SearchPanes options for this field if configured

Returns SearchPaneOptions | undefined
SearchPanes options
- Defined in column.ts:155
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
- Defined in column.ts:164