Documentation

Class: TreeGrid

mvcomponents/treegrid. TreeGrid

TreeGrid simples para exibição de dados tabulados de forma hierarquica atravez de algum atributo que represente o identificador do item agrupador.

new TreeGrid()

Methods

addColumns(columns)

Parameters:
Name Type Description
columns Array.<ITreeGridColumn>
Returns:
Type
TreeGrid

clearSelection()

Returns:
Type
TreeGrid

getCheckeds()

Retorna todos os valores representados pelas linhas que estão checadas na treegrid para a coluna que está marcada como "checkable".

getCheckedsIndexes()

Retorna um array com o indice de todos os valores checados na treegrid para a coluna que está marcada como "checkable".

getData()

Returns:
Type
Array.<T>

getParentColumn()

Returns:
Type
string

getPrimaryColumn()

Returns:
Type
string

getSelectedGroups()

Retorna todos os valores representados pelas linhas que estão selecionadas no treegrid.

getSelectedItems()

Retorna todos os valores representados pelas linhas que estão selecionadas no treegrid.

refresh()

Returns:
Type
TreeGrid

setBottom(bottom)

Parameters:
Name Type Description
bottom number
Returns:
Type
this

setCheckeds(indice)

marcar como checado um ou varios itens da datagrid de acordo com o indice informado para a coluna marcada como checkable.

Parameters:
Name Type Description
indice Array.<number>
Returns:
Type
TreeGrid

setColumns(columns)

método usado para indicar as colunas do tree grid.

Parameters:
Name Type Description
columns Array.<ITreeGridColumn>
Returns:
Type
TreeGrid
Examples
this.mytreegrid.setColumns([
  {name: "id", title:"cod"}
  ,{name: "name", title:"name"}
])
//exemplo com o metodo "render" retornando um valor custumizado para a coluna "exp"
this.mytreegrid.setColumns([
  {name: "id", title:"cod"}
  ,{name: "name", title:"name"}
  ,{name:"exp", title:"exp.", render:item => item.exp - 25 }
])
//exemplo com agrupamento dinâmico atravez da opção "group:true"
this.mytreegrid.setColumns([
  {name: "id", title:"cod" , group:true}
  ,{name: "name", title:"name"}
])

//obs. o agrupamento só é aplicável para atributos de primeiro nível dos objetos da coleção
//caso seja necessário usar um atributo de segundo nivel é necessário realizar um
//array.map antes do setData do treegrid
com agrupamento dinâmico atravez da opção "group:true"
this.mytreegrid.setColumns([
  {name: "id", title:"cod"}
  ,{name: "name", title:"name"}
  ,{name: "user.login" , titel:"login" , group:true} //não vai funcionar, pois é um atributo de segundo nível.
])

//deve ser trocado por
,{name: "_user_login" , title:"login", group:true}
...
//e durante o setData usado o metodo "Array.map" para a conversão (ou no servidor)
this.mytreegrid.setData(list.map(item => {
  item._user_login = item.user.login; //campo virtual
  return item;
}))

setData(data)

Parameters:
Name Type Description
data Array.<Object>
Returns:
Type
TreeGrid

setParentColumn(parentColumn)

Parameters:
Name Type Description
parentColumn string
Returns:
Type
TreeGrid

setPrimaryColumn(primaryColumn)

Parameters:
Name Type Description
primaryColumn string
Returns:
Type
TreeGrid