MetaFox

GridColumn
in package

Class GridColumn.

Describe GridData column.

Tags
SuppressWarnings

(PHPMD.LongVariable)

SuppressWarnings

(PHPMD.TooManyMethods)

SuppressWarnings

(PHPMD.BooleanArgumentFlag)

Table of Contents

Properties

$attributes  : array<string|int, mixed>

Methods

__construct()  : mixed
action()  : $this
alignCenter()  : $this
Align column content to center.
alignLeft()  : $this
Align column content to left.
alignRight()  : $this
Align column content to right.
asDateTime()  : $this
Render as Date Time cell.
asEmail()  : $this
Render as Email cell with a mailto hyperlink.
asFeaturedUser()  : $this
asHtml()  : self
asIcon()  : static
asIconStatus()  : static
asId()  : static
asNumber()  : $this
Set frontend render as number format.
asNumeral()  : $this
asPreviewUrl()  : self
asPricing()  : static
asToggle()  : $this
Render as a toggle active cell.
asToggleActive()  : $this
Render as a toggle active cell.
asToggleDefault()  : $this
Render as a toggle active cell.
asYesNo()  : $this
Render as YesNoCell.
asYesNoIcon()  : static
editable()  : $this
Set column is editable.
flex()  : $this
Set the column flex weight.
header()  : $this
Set column header title.
hint()  : static
linkTo()  : $this
Add link ref to a field name in the data grid.
minWidth()  : static
polling()  : self
reload()  : $this
renderAs()  : $this
Set align client.
setAttribute()  : $this
Set attribute.
sortable()  : $this
Add sortable to the grid column.
sortableField()  : $this
tagName()  : static
target()  : static
toArray()  : array<string, mixed>
tooltip()  : static
truncateLines()  : $this
Column should be multiple line with specific lines.
variant()  : static
width()  : $this
Set column width in pixel.

Properties

$attributes

private array<string|int, mixed> $attributes = []

<string,string|int>

Methods

__construct()

public __construct(string $field) : mixed
Parameters
$field : string

action()

public action(string $action) : $this
Parameters
$action : string
Return values
$this

alignCenter()

Align column content to center.

public alignCenter() : $this
Return values
$this

alignLeft()

Align column content to left.

public alignLeft() : $this
Return values
$this

alignRight()

Align column content to right.

public alignRight() : $this
Return values
$this

asDateTime()

Render as Date Time cell.

public asDateTime([string $format = 'medium' ][, bool $showTime = true ]) : $this
Parameters
$format : string = 'medium'
$showTime : bool = true
Return values
$this

asEmail()

Render as Email cell with a mailto hyperlink.

public asEmail(string $target) : $this
Parameters
$target : string
Return values
$this

asFeaturedUser()

public asFeaturedUser() : $this
Return values
$this

asHtml()

public asHtml() : self
Return values
self

asIcon()

public asIcon() : static
Return values
static

asIconStatus()

public asIconStatus([array<string, mixed>|null $config = null ][, array<string|int, mixed>|null $polling = null ]) : static
Parameters
$config : array<string, mixed>|null = null
$polling : array<string|int, mixed>|null = null
Return values
static

asId()

public asId() : static
Return values
static

asNumber()

Set frontend render as number format.

public asNumber() : $this
Return values
$this

asPreviewUrl()

public asPreviewUrl() : self
Return values
self

asPricing()

public asPricing() : static
Return values
static

asToggle()

Render as a toggle active cell.

public asToggle(string $action[, bool $reload = false ]) : $this
Parameters
$action : string
$reload : bool = false
Return values
$this

asToggleActive()

Render as a toggle active cell.

public asToggleActive() : $this
Return values
$this

asToggleDefault()

Render as a toggle active cell.

public asToggleDefault() : $this
Return values
$this

asYesNo()

Render as YesNoCell.

public asYesNo() : $this
Return values
$this

asYesNoIcon()

public asYesNoIcon() : static
Return values
static

editable()

Set column is editable.

public editable() : $this
Return values
$this

flex()

Set the column flex weight.

public flex([mixed $flex = 1 ][, mixed $minWidth = 200 ]) : $this
Parameters
$flex : mixed = 1

Example: 1

$minWidth : mixed = 200

, Example 200

Return values
$this

header()

Set column header title.

public header(string $header) : $this
Parameters
$header : string
Return values
$this

hint()

public hint(string $key[, string|null $default = null ]) : static
Parameters
$key : string
$default : string|null = null
Return values
static

linkTo()

Add link ref to a field name in the data grid.

public linkTo(string $field) : $this
Parameters
$field : string
Return values
$this

minWidth()

public minWidth(int $minWidth) : static
Parameters
$minWidth : int
Return values
static

polling()

public polling(array<string|int, mixed> $config) : self
Parameters
$config : array<string|int, mixed>
Return values
self

reload()

public reload([bool $value = true ]) : $this
Parameters
$value : bool = true
Return values
$this

renderAs()

Set align client.

public renderAs(string $renderCell) : $this
Parameters
$renderCell : string
Return values
$this

setAttribute()

Set attribute.

public setAttribute(string $name, mixed $value) : $this
Parameters
$name : string
$value : mixed
Return values
$this

sortable()

Add sortable to the grid column.

public sortable([bool $sortable = true ]) : $this
Parameters
$sortable : bool = true
Return values
$this

sortableField()

public sortableField(string $name) : $this
Parameters
$name : string
Return values
$this

tagName()

public tagName(string $tagName) : static
Parameters
$tagName : string
Return values
static

target()

public target(string $target) : static
Parameters
$target : string
Return values
static

toArray()

public toArray() : array<string, mixed>
Return values
array<string, mixed>

tooltip()

public tooltip(string $tooltip) : static
Parameters
$tooltip : string
Return values
static

truncateLines()

Column should be multiple line with specific lines.

public truncateLines([int $lines = 2 ]) : $this
Parameters
$lines : int = 2
Return values
$this

variant()

public variant(string $variant) : static
Parameters
$variant : string
Return values
static

width()

Set column width in pixel.

public width(int $width[, int $minWidth = null ]) : $this
Parameters
$width : int

Example: 1

$minWidth : int = null

Example: 1

Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results