You are here

Home » API reference » Views Ticker 7 » views_ticker_style_plugin.inc » views_ticker_style_plugin

function views_ticker_style_plugin::option_definition in Views Ticker 7

Same name and namespace in other branches
  1. 6.2 includes/views_ticker_style_plugin.inc \views_ticker_style_plugin::option_definition()
  2. 7.2 includes/views_ticker_style_plugin.inc \views_ticker_style_plugin::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

includes/views_ticker_style_plugin.inc, line 14
Contains the views ticker style plugin.

Class

views_ticker_style_plugin
Style plugin to render each item in an ordered or unordered list.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['scroller_type'] = array(
    'default' => 'horizontal',
  );
  $options['hscroller_Options']['default'] = array(
    'hscroller_speed' => 30,
    'hscroller_direction' => 'left',
    'hscroller_mouseover' => 0,
    'hscroller_delay' => 0,
    'hscroller_bounce' => 0,
  );
  $options['vscroller_Options']['default'] = array(
    'vscroller_speed' => 30,
    'vscroller_direction' => 'up',
    'vscroller_mouseover' => 0,
    'vscroller_delay' => 0,
    'vscroller_bounce' => 0,
  );
  $options['vTicker_Options']['default'] = array(
    'vTicker_mouseover' => 0,
    'vTicker_speed' => 500,
    'vTicker_pause' => 1000,
    'vTicker_items' => 5,
    'vTicker_direction' => 'up',
  );
  return $options;
}