function views_timelinejs_plugin_style_timelinejs::option_definition in Views TimelineJS integration 7.3

Same name and namespace in other branches

1. 7 views_timelinejs_plugin_style_timelinejs.inc \views_timelinejs_plugin_style_timelinejs::option_definition()

Information about options for all kinds of purposes will be held here.

@code 'option_name' => array(

• 'default' => default value,
• 'translatable' => (optional) TRUE/FALSE (wrap in t() on export if true),
• 'contains' => (optional) array of items this contains, with its own defaults, etc. If contains is set, the default will be ignored and assumed to be array().
• 'bool' => (optional) TRUE/FALSE Is the value a boolean value. This will change the export format to TRUE/FALSE instead of 1/0.
• 'export' => (optional) FALSE or a callback for special export handling if necessary.
• 'unpack_translatable' => (optional) callback for special handling for translating data within the option, if necessary.

),

Return value

array Returns the options of this handler/plugin.

Overrides views_plugin_style::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

./views_timelinejs_plugin_style_timelinejs.inc, line 18

Class

views_timelinejs_plugin_style_timelinejs

Style plugin to render items as TimelineJS3 slides.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['timeline_config'] = array(
    'contains' => array(
      'width' => array(
        'default' => '100%',
      ),
      'height' => array(
        'default' => '40em',
      ),
      'hash_bookmark' => array(
        'default' => '',
      ),
      'scale_factor' => array(
        'default' => '2',
      ),
      'timenav_position' => array(
        'default' => 'bottom',
      ),
      'timenav_height' => array(
        'default' => '',
      ),
      'timenav_height_percentage' => array(
        'default' => '',
      ),
      'timenav_mobile_height_percentage' => array(
        'default' => '',
      ),
      'timenav_height_min' => array(
        'default' => '',
      ),
      'start_at_end' => array(
        'default' => '',
      ),
      'language' => array(
        'default' => '',
      ),
    ),
  );
  $options['additional_config'] = array(
    'contains' => array(
      'font' => array(
        'default' => '',
      ),
      'start_at_current' => array(
        'default' => '',
      ),
    ),
  );
  $options['timeline_fields'] = array(
    'contains' => array(
      'caption' => array(
        'default' => '',
      ),
      'credit' => array(
        'default' => '',
      ),
      'media' => array(
        'default' => '',
      ),
      'thumbnail' => array(
        'default' => '',
      ),
      'group' => array(
        'default' => '',
      ),
      'start_date' => array(
        'default' => '',
      ),
      'end_date' => array(
        'default' => '',
      ),
      'display_date' => array(
        'default' => '',
      ),
      'text' => array(
        'default' => '',
      ),
      'headline' => array(
        'default' => '',
      ),
      'background' => array(
        'default' => '',
      ),
      'background_color' => array(
        'default' => '',
      ),
      'type' => array(
        'default' => '',
      ),
      'unique_id' => array(
        'default' => '',
      ),
    ),
  );
  return $options;
}