NexusHoratio.widget.GridColumn

Members

---

field :string

Details

Type

string

Source

lib/widget.js, line 1244

---

title :string

Details

Type

string

Source

lib/widget.js, line 1249

---

uid :string

Details

Type

string

Source

lib/widget.js, line 1254

Methods

---

defaultClassesFunc( record, field ) → {Array.<string>}

Description

This default implementation uses the field.

Parameters

Name	Type	Description
record	NexusHoratio.widget.Grid~GridRecord	Record to style.
field	string	Field to style.

Returns

Array.<string>

CSS classes for item.

Details

Implements

NexusHoratio.widget.GridColumn~ColumnClassesFunc

Source

lib/widget.js, line 1226

---

defaultRenderFunc( record, field ) → {NexusHoratio.widget.Widget}

Parameters

Name	Type	Description
record	NexusHoratio.widget.Grid~GridRecord	Record to render.
field	string	Field to render.

Returns

NexusHoratio.widget.Widget

Rendered content.

Details

Implements

NexusHoratio.widget.GridColumn~RenderFunc

Source

lib/widget.js, line 1238

---

render( record ) → {NexusHoratio.widget.Widget}

Description

Use the registered rendering function to create the widget.

Parameters

Name	Type	Description
record	NexusHoratio.widget.Grid~GridRecord	Record to render.

Returns

NexusHoratio.widget.Widget

Rendered content.

Details

Source

lib/widget.js, line 1264

---

classList( record ) → {Array.<string>}

Description

Use the registered ColumnClassesFunc to return CSS classes.

Parameters

Name	Type	Description
record	NexusHoratio.widget.Grid~GridRecord	Record to examine.

Returns

Array.<string>

CSS classes for this record.

Details

Source

lib/widget.js, line 1279

---

colClassesFunc( func ) → {NexusHoratio.widget.GridColumn}

Description

Sets the function used to style a cell.

If no value is passed, it will set the default function.

Parameters

Name	Type	Description
func	NexusHoratio.widget.GridColumn~ColumnClassesFunc	Styling function.

Returns

NexusHoratio.widget.GridColumn

This instance, for chaining.

Details

Source

lib/widget.js, line 1292

---

renderFunc( [ func ] ) → {NexusHoratio.widget.GridColumn}

Description

Sets the function used to render the column.

If no value is passed, it will set the default function.

Parameters

Name	Type	Attributes	Description
func	NexusHoratio.widget.GridColumn~RenderFunc	<optional>	Rendering function.

Returns

NexusHoratio.widget.GridColumn

This instance, for chaining.

Details

Source

lib/widget.js, line 1317

---

setTitle( [ title ] ) → {NexusHoratio.widget.GridColumn}

Description

Set the title string.

If no value is passed, it will default back to the name of the field.

Parameters

Name	Type	Attributes	Description
title	string	<optional>	New title for the column.

Returns

NexusHoratio.widget.GridColumn

This instance, for chaining.

Details

Source

lib/widget.js, line 1341

Type Definitions

---

ColumnClassesFunc( record, field ) → {Array.<string>}

Parameters

Name	Type	Description
record	NexusHoratio.widget.Grid~GridRecord	Record to style.
field	string	Field to style.

Returns

Array.<string>

CSS classes for item.

Details

Type

function

Source

lib/widget.js, line 1182

---

RenderFunc( record, field ) → {NexusHoratio.widget.Widget}

Parameters

Name	Type	Description
record	NexusHoratio.widget.Grid~GridRecord	Record to render.
field	string	Field to render.

Returns

NexusHoratio.widget.Widget

Rendered content.

Details

Type

function

Source

lib/widget.js, line 1190