nginstack

Module: @nginstack/web-framework/lib/settings/newSettingsGrid

(require("@nginstack/web-framework/lib/settings/newSettingsGrid"))(settingsId [, options])

Cria uma grade para o preenchimento das configurações gerais.

Será criado um campo para cada configuração com o mesmo nome da configuração. Para configurações que aceitam múltiplos valores, o tipo desse campo será "grid" e será criado um dataset temporário para armazenar os múltiplos valores da configuração. Esses valores poderão ser lidos pelo campo "value" do DataSet e da grade detalhe.

Caso todas as configurações possuam o mesmo "Grupo", ele será suprimido na criação dos campos e sugerido como título da grade, caso a opção title não tenha sido informada.

Parameters:
Name Type Argument Description
settingsId string | number | DBKey | Array.<string> | Array.<number> | Array.<DBKey>

Identificador de uma configuração específica ou de uma seção de configurações. Também pode ser informado um array de identificadores.
options Object <optional>

Opções de criação da grade.

Properties
Name Type Argument Description
process module:@nginstack/web-framework/lib/process/Process~Process <optional>

Processo onde deve ser criada a grade. Caso não seja informado, será criada no processo em uso pelo usuário.
title string <optional>

Título da grade. Caso não seja informado, será utilizado o título "Configurações".
name string <optional>

Nome da grade. Caso não seja informado, será gerado um nome único.
help string <optional>

Ajuda da grade. Caso não seja informado, será gerado um texto genérico.
showResetToDefaultsButton boolean <optional>

Indica se o botão "Redefinir os valores padrões" deve ser exibido na grade.
Returns:

Grade pré-configurada para o preenchimento das configurações.

Type
module:@nginstack/web-framework/lib/grid/Grid~Grid
Examples
const newSettingsGrid = require('@nginstack/web-framework/lib/settings/newSettingsGrid');

this.interaction('main', function () {
  const grid = newSettingsGrid('wf.login', {
    title: 'Configurações da tela de login padrão',
    showResetToDefaultsButton: true
  });
  grid.write();
});
const newSettingsGrid = require('@nginstack/web-framework/lib/settings/newSettingsGrid');

this.interaction('main', function () {
  const grid = newSettingsGrid(['wf.login.colors.primary', 'wf.login.colors.secondary'], {
    title: 'Configurações de cores da tela de login padrão'
  });
  grid.write();
});