sc_widget_config($arrayOptions)
|
|
La macro sc_widget_config() permite modificar dinámicamente las propiedades visuales del widget en ejecución. Debe utilizarse en el evento onWidgetLoad y aplica las configuraciones solo al widget actual.
El parámetro recibido es un array asociativo que contiene las opciones de configuración del widget.
Ejemplo de estructura del array:
sc_widget_config([
'title' => 'Mi título',
'border-color' => '#FF0000'
]);
Parámetros por tipo de widget
Las opciones disponibles para configuración dependen del tipo de widget que se va a modificar. Consulta a continuación las opciones separadas por tipo.
Widget de Enlace
| Parámetro |
Valor |
Descripción |
title |
'title' => 'Título del widget' |
Define el título mostrado en la parte superior del widget. |
border-color |
'border-color' => '#FF0000' |
Color del borde del widget, en formato hexadecimal. |
Widget de División
| Parámetro |
Valor |
Descripción |
title |
'title' => 'Sección Principal' |
Título de la sección creada por el widget de división. |
subtitle |
'subtitle' => 'Descripción complementaria' |
Texto mostrado debajo del título del divisor. |
background-color |
'background-color' => '#F1F1F1' |
Color de fondo del widget, en formato hexadecimal. |
border-color |
'border-color' => '#CCCCCC' |
Color del borde del widget, en formato hexadecimal. |
Widget de Índice
| Parámetro |
Valor |
Descripción |
title |
'title' => 'Indicador de Ventas' |
Título mostrado en la parte superior del widget de índice. |
legend |
'legend' => 'Comparado con el mes anterior' |
Texto mostrado debajo del valor principal del índice. |
background-color |
'background-color' => '#E0FFE0' |
Color de fondo del widget, en formato hexadecimal. |
border-color |
'border-color' => '#00CC00' |
Color del borde del widget, en formato hexadecimal. |
Ejemplo completo
$widgetName = sc_widget_name();
if ($widgetName == 'indice_ventas') {
sc_widget_config([
'title' => 'Ventas del Mes',
'legend' => 'Comparado con el mes anterior',
'background-color' => '#f0f0f0',
'border-color' => '#999999',
]);
}
En el ejemplo anterior, la macro sc_widget_config() se utiliza para aplicar configuraciones visuales al widget identificado como indice_ventas.
|
Macro Scope
|
Dashboard
|
allMacros onWidgetLoad
|
|