Documentation

Class: Select

mvcomponents/input. Select

Componente utilizado para a seleção de registros

new Select()

Implements:
  • ISelect
Example
import {Select} from "mvcomponents/input";

interface IObjeto {
  id: number;
  descricao: string;
}

let dadosSelect:IObjeto[] = [
    {id: 1,descricao: "Primeiro item"},
    {id: 2,descricao: "Segundo item"}
];

let select:Select<IObjeto> = new Select<IObjeto>()
     .setName("select")
     .setValueField("id")
     .setDescriptionField("descricao")
     .setData(dadosSelect);

this.append(select);

Extends

  • ABaseInput

Methods

addValues()

Adiciona itens a lista de itens selecionados caso a opção multiple esteja configurada como true.

Returns:
Type
Select

clear()

Remove todos os itens

Returns:
Type
this

getAssignedProperty(field)

Informa qual atributo o formulário irá manipular durante o getData

Parameters:
Name Type Description
field string

identifica o valor
Returns:
Type
this

getByValue()

Recupera o Objeto definido na instancia do Select de acordo com valor.

Returns:

Retorna de acordo com Objeto definido na instancia do Select.

Type
any

getData()

Returns:
Type
Array.<T>

getDescriptionField()

Retorna qual é o campo descritivo

Returns:
Type
string

getValue()

Recupera o valor selecionado no Select.

Returns:

Retorna de acordo com Objeto definido na instancia do Select.

Type
any

getValueField()

Retorna qual é o campo que identifica o valor

Returns:
Type
string

getValues()

Recupera os valores selecionados no Select caso a opção multiple esteja configurada como true.

Returns:

Retorna uma lista de objetos de acordo com Objeto definido na instancia do Select.

Type
Array.<any>

setAssignedProperty(field)

Informa qual atributo o formulário irá manipular durante o getData

Parameters:
Name Type Description
field string

identifica o valor
Returns:
Type
this

setData(data)

Atualiza os dados disponíveis para a seleção

Parameters:
Name Type Description
data Array.<any>

Dados disponíveis no Select.
Returns:
Type
this

setDescriptionField(field)

Informa qual é o campo descritivo dos dados

Parameters:
Name Type Description
field string

descritivo dos dados
Returns:
Type
this

setDisplayItem(display)

Altera a exibição do item do select quando um item form selecionado

Parameters:
Name Type Description
display function
Returns:
Type
Select
Example
let select:Select<IObjeto> = new Select<IObjeto>()
    .setDisplayItem(item => `<strong>Nome:${item.nome}</strong>`);

setDisplayListItem(display)

Altera a exibição dos itens do select quando a lista estiver aberta

Parameters:
Name Type Description
display function
Returns:
Type
Select
Example
let select:Select<IObjeto> = new Select<IObjeto>()
    .setDisplayListItem(item => `<strong>Nome:${item.nome}</strong>`);

setNoResults(resultDisplay)

Altera a exibição na lista quando um termo não for encontrado

Parameters:
Name Type Description
resultDisplay function
Returns:
Type
Select
Example
let select:Select<IObjeto> = new Select<IObjeto>()
    .setNoResults(term => `o item não foi encontrado!`);

setPlaceholder(placeholder)

Altera o "placeholder" do Select

Parameters:
Name Type Description
placeholder string

Texto que irá aparecer para auxiliar o usuário.
Returns:
Type
Select
Example
let select:Select<IObjeto> = new Select<IObjeto>()
    .setPlaceholder("Selecione um item..");

setValue(value)

Atualiza o valor do input com base nos dados carregados

Parameters:
Name Type Description
value any

Objeto de acordo definido na instancia do Select.
Returns:
Type
Select
Example
itSelect.setValue({id:1});

setValueField(field)

Informa qual campo identifica o valor

Parameters:
Name Type Description
field string

identifica o valor
Returns:
Type
this

setValues()

Altera a lista de itens selecionados caso a opção multiple esteja configurada como true.

Returns:
Type
Select