sc_widget_config($arrayOptions)
|
|
A macro sc_widget_config() permite alterar dinamicamente as propriedades visuais do widget em execução. Ela deve ser utilizada no evento onWidgetLoad e aplica as configurações somente ao widget atual.
O parâmetro recebido é um array associativo contendo as opções de configuração do widget.
Exemplo de estrutura do array:
sc_widget_config([
'title' => 'Meu título',
'border-color' => '#FF0000'
]);
Parâmetros por tipo de widget
As opções disponíveis para configuração dependem do tipo de Widget que será alterado. Confira a baixo as opções separadas por tipo.
Widget de Ligação
| Parâmetro |
Valor |
Descrição |
title |
'title' => 'Título do widget' |
Define o título exibido no topo do widget. |
border-color |
'border-color' => '#FF0000' |
Cor da borda do widget, em formato hexadecimal. |
Widget de Divisão
| Parâmetro |
Valor |
Descrição |
title |
'title' => 'Seção Principal' |
Título da seção criada pelo widget de divisão. |
subtitle |
'subtitle' => 'Descrição complementar' |
Texto exibido abaixo do título do divisor. |
background-color |
'background-color' => '#F1F1F1' |
Cor de fundo do widget, em formato hexadecimal. |
border-color |
'border-color' => '#CCCCCC' |
Cor da borda do widget, em formato hexadecimal. |
Widget de Índice
| Parâmetro |
Valor |
Descrição |
title |
'title' => 'Indicador de Vendas' |
Título exibido no topo do widget de índice. |
legend |
'legend' => 'Comparado ao mês anterior' |
Texto exibido abaixo do valor principal do índice. |
background-color |
'background-color' => '#E0FFE0' |
Cor de fundo do widget, em formato hexadecimal. |
border-color |
'border-color' => '#00CC00' |
Cor da borda do widget, em formato hexadecimal. |
Exemplo completo
$widgetName = sc_widget_name();
if ($widgetName == 'indice_vendas') {
sc_widget_config([
'title' => 'Vendas do Mês',
'legend' => 'Comparado ao mês anterior',
'background-color' => '#f0f0f0',
'border-color' => '#999999',
]);
}
No exemplo acima, a macro sc_widget_config() é utilizada para aplicar configurações visuais ao widget identificado como indice_vendas.
|
Escopo da Macro
|
Dashboard
|
allMacros onWidgetLoad
|
|