function charts_settings_form in Charts 7.2
Same name and namespace in other branches
- 8 includes/charts.pages.inc \charts_settings_form()
Module settings page. Users can set the default layout of their charts.
Parameters
$form: The form array to which this form will be added.
$defaults: An array of existing values which will be used to populate defaults.
$field_options: An array of key => value names of fields within this chart.
$parents: If all the contents of this form should be parented under a particular namespace, an array of parent names that will be prepended to each element's #parents property.
Return value
The form with the chart settings added.
2 calls to charts_settings_form()
- charts_default_settings_form in includes/
charts.pages.inc - Menu callback; Configure the site-wide defaults for charts.
- charts_plugin_style_chart::options_form in views/
charts_plugin_style_chart.inc - Generate a form for setting options.
File
- includes/
charts.pages.inc, line 23 - Menu callbacks for Charts module.
Code
function charts_settings_form($form, $defaults = array(), $field_options = array(), $parents = array()) {
// Ensure all defaults are set.
$options = array_merge(charts_default_settings(), $defaults);
$form['#attached']['library'][] = array(
'charts',
'charts.admin',
);
// Get a list of available chart libraries.
$charts_info = charts_info();
$library_options = array();
foreach ($charts_info as $library_name => $library_info) {
$library_options[$library_name] = $library_info['label'];
}
$form['library'] = array(
'#title' => t('Charting library'),
'#type' => 'select',
'#options' => $library_options,
'#default_value' => $options['library'],
'#required' => TRUE,
'#access' => count($library_options) > 1,
'#attributes' => array(
'class' => array(
'chart-library-select',
),
),
'#weight' => -15,
'#parents' => array_merge($parents, array(
'library',
)),
);
$chart_types = charts_type_info();
$type_options = array();
foreach ($chart_types as $chart_type => $chart_type_info) {
$type_options[$chart_type] = $chart_type_info['label'];
}
$form['type'] = array(
'#title' => t('Chart type'),
'#type' => 'radios',
'#default_value' => $options['type'],
'#options' => $type_options,
'#required' => TRUE,
'#weight' => -20,
'#attributes' => array(
'class' => array(
'chart-type-radios',
'container-inline',
),
),
'#parents' => array_merge($parents, array(
'type',
)),
);
// Set data attributes to identify special properties of different types.
foreach ($chart_types as $chart_type => $chart_type_info) {
if ($chart_type_info['axis_inverted']) {
$form['type'][$chart_type]['#attributes']['data-axis-inverted'] = TRUE;
}
if ($chart_type_info['axis'] === CHARTS_SINGLE_AXIS) {
$form['type'][$chart_type]['#attributes']['data-axis-single'] = TRUE;
}
}
if ($field_options) {
$first_field = key($field_options);
$field_keys = array_diff($field_options, array(
$first_field => NULL,
));
$form['fields']['#theme'] = 'charts_settings_fields';
$form['fields']['label_field'] = array(
'#type' => 'radios',
'#title' => t('Label field'),
'#options' => $field_options + array(
'' => t('No label field'),
),
'#default_value' => isset($options['label_field']) ? $options['label_field'] : $first_field,
'#weight' => -10,
'#parents' => array_merge($parents, array(
'label_field',
)),
);
$form['fields']['data_fields'] = array(
'#type' => 'checkboxes',
'#title' => t('Data fields'),
'#options' => $field_options,
'#default_value' => isset($options['data_fields']) ? $options['data_fields'] : array_diff(array_keys($field_options), array(
$first_field,
)),
'#weight' => -9,
'#parents' => array_merge($parents, array(
'data_fields',
)),
);
$color_count = 0;
foreach ($field_options as $field_name => $field_label) {
$form['fields']['field_colors'][$field_name] = array(
'#type' => 'textfield',
'#attributes' => array(
'TYPE' => 'color',
),
'#size' => 10,
'#maxlength' => 7,
'#theme_wrappers' => array(),
'#default_value' => !empty($options['field_colors'][$field_name]) ? $options['field_colors'][$field_name] : $options['colors'][$color_count],
'#parents' => array_merge($parents, array(
'field_colors',
$field_name,
)),
);
$color_count++;
}
}
$form['display'] = array(
'#title' => t('Display'),
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['display']['title'] = array(
'#title' => t('Chart title'),
'#type' => 'textfield',
'#default_value' => $options['title'],
'#parents' => array_merge($parents, array(
'title',
)),
);
$form['display']['title_position'] = array(
'#title' => t('Title position'),
'#type' => 'select',
'#options' => array(
'' => t('None'),
'out' => t('Outside'),
'in' => t('Inside'),
),
'#default_value' => $options['title_position'],
'#parents' => array_merge($parents, array(
'title_position',
)),
);
$form['display']['tooltips'] = array(
'#title' => t('Tooltips'),
'#type' => 'select',
'#options' => array(
'' => t('Disabled'),
'TRUE' => t('Enabled'),
),
'#description' => t('Show data details on mouse over? Note: unavailable for print or on mobile devices.'),
'#default_value' => $options['tooltips'],
'#parents' => array_merge($parents, array(
'tooltips',
)),
);
$form['display']['data_labels'] = array(
'#title' => t('Data labels'),
'#type' => 'select',
'#options' => array(
'' => t('Disabled'),
'TRUE' => t('Enabled'),
),
'#default_value' => $options['data_labels'],
'#description' => t('Show data details as labels on chart? Note: recommended for print or on mobile devices.'),
'#parents' => array_merge($parents, array(
'data_labels',
)),
);
$form['display']['legend_position'] = array(
'#title' => t('Legend position'),
'#type' => 'select',
'#options' => array(
'' => t('None'),
'top' => t('Top'),
'right' => t('Right'),
'bottom' => t('Bottom'),
'left' => t('Left'),
),
'#default_value' => $options['legend_position'],
'#parents' => array_merge($parents, array(
'legend_position',
)),
);
$form['display']['colors'] = array(
'#title' => t('Chart colors'),
'#theme_wrappers' => array(
'form_element',
),
'#prefix' => '<div class="chart-colors">',
'#suffix' => '</div>',
);
for ($color_count = 0; $color_count < 10; $color_count++) {
$form['display']['colors'][$color_count] = array(
'#type' => 'textfield',
'#attributes' => array(
'TYPE' => 'color',
),
'#size' => 10,
'#maxlength' => 7,
'#theme_wrappers' => array(),
'#suffix' => ' ',
'#default_value' => $options['colors'][$color_count],
'#parents' => array_merge($parents, array(
'colors',
$color_count,
)),
);
}
$form['display']['background'] = array(
'#title' => t('Background color'),
'#type' => 'textfield',
'#size' => 10,
'#maxlength' => 7,
'#attributes' => array(
'placeholder' => t('transparent'),
),
'#description' => t('Leave blank for a transparent background.'),
'#default_value' => $options['background'],
'#parents' => array_merge($parents, array(
'background',
)),
);
$form['display']['dimensions'] = array(
'#title' => t('Dimensions'),
'#theme_wrappers' => array(
'form_element',
),
'#description' => t('If dimensions are left empty, the chart will fill its containing element.'),
);
$form['display']['dimensions']['width'] = array(
'#type' => 'textfield',
'#attributes' => array(
'TYPE' => 'number',
'step' => 1,
'min' => 0,
'max' => 9999,
'placeholder' => t('auto'),
),
'#default_value' => $options['width'],
'#size' => 8,
'#suffix' => ' x ',
'#theme_wrappers' => array(),
'#parents' => array_merge($parents, array(
'width',
)),
);
$form['display']['dimensions']['height'] = array(
'#type' => 'textfield',
'#attributes' => array(
'TYPE' => 'number',
'step' => 1,
'min' => 0,
'max' => 9999,
'placeholder' => t('auto'),
),
'#default_value' => $options['height'],
'#size' => 8,
'#suffix' => ' px',
'#theme_wrappers' => array(),
'#parents' => array_merge($parents, array(
'height',
)),
);
$form['xaxis'] = array(
'#title' => t('Horizontal axis'),
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#attributes' => array(
'class' => array(
'chart-xaxis',
),
),
);
$form['xaxis']['title'] = array(
'#title' => t('Custom title'),
'#type' => 'textfield',
'#default_value' => $options['xaxis_title'],
'#parents' => array_merge($parents, array(
'xaxis_title',
)),
);
$form['xaxis']['labels_rotation'] = array(
'#title' => t('Labels rotation'),
'#type' => 'select',
'#options' => array(
0 => '0°',
30 => '30°',
45 => '45°',
60 => '60°',
90 => '90°',
),
// This is only shown on non-inverted charts.
'#attributes' => array(
'class' => array(
'axis-inverted-hide',
),
),
'#default_value' => $options['xaxis_labels_rotation'],
'#parents' => array_merge($parents, array(
'xaxis_labels_rotation',
)),
);
$form['yaxis'] = array(
'#title' => t('Vertical axis'),
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#attributes' => array(
'class' => array(
'chart-yaxis',
),
),
);
$form['yaxis']['title'] = array(
'#title' => t('Custom title'),
'#type' => 'textfield',
'#default_value' => $options['yaxis_title'],
'#parents' => array_merge($parents, array(
'yaxis_title',
)),
);
$form['yaxis']['minmax'] = array(
'#title' => t('Value range'),
'#theme_wrappers' => array(
'form_element',
),
);
$form['yaxis']['minmax']['min'] = array(
'#type' => 'textfield',
'#attributes' => array(
'TYPE' => 'number',
'max' => 999999,
'placeholder' => t('Minimum'),
),
'#default_value' => $options['yaxis_min'],
'#size' => 12,
'#parents' => array_merge($parents, array(
'yaxis_min',
)),
'#suffix' => ' ',
'#theme_wrappers' => array(),
);
$form['yaxis']['minmax']['max'] = array(
'#type' => 'textfield',
'#attributes' => array(
'TYPE' => 'number',
'max' => 999999,
'placeholder' => t('Maximum'),
),
'#default_value' => $options['yaxis_max'],
'#size' => 12,
'#parents' => array_merge($parents, array(
'yaxis_max',
)),
'#theme_wrappers' => array(),
);
$form['yaxis']['prefix'] = array(
'#title' => t('Value prefix'),
'#type' => 'textfield',
'#default_value' => $options['yaxis_prefix'],
'#size' => 12,
'#parents' => array_merge($parents, array(
'yaxis_prefix',
)),
);
$form['yaxis']['suffix'] = array(
'#title' => t('Value suffix'),
'#type' => 'textfield',
'#default_value' => $options['yaxis_suffix'],
'#size' => 12,
'#parents' => array_merge($parents, array(
'yaxis_suffix',
)),
);
$form['yaxis']['decimal_count'] = array(
'#title' => t('Decimal count'),
'#type' => 'textfield',
'#attributes' => array(
'TYPE' => 'number',
'step' => 1,
'min' => 0,
'max' => 20,
'placeholder' => t('auto'),
),
'#default_value' => $options['yaxis_decimal_count'],
'#size' => 5,
'#description' => t('Enforce a certain number of decimal-place digits in displayed values.'),
'#parents' => array_merge($parents, array(
'yaxis_decimal_count',
)),
);
$form['yaxis']['labels_rotation'] = array(
'#title' => t('Labels rotation'),
'#type' => 'select',
'#options' => array(
0 => '0°',
30 => '30°',
45 => '45°',
60 => '60°',
90 => '90°',
),
// This is only shown on inverted charts.
'#attributes' => array(
'class' => array(
'axis-inverted-show',
),
),
'#default_value' => $options['yaxis_labels_rotation'],
'#parents' => array_merge($parents, array(
'yaxis_labels_rotation',
)),
);
return $form;
}