Component: ojTimeline

Oracle® JavaScript Extension Toolkit (JET)
3.2.0

E87541-01

QuickNav

Options


Context Objects
Sub-ID's

oj. ojTimeline extends oj.dvtTimeComponent

Version:
  • 3.2.0
Since:
  • 1.1.0

JET Timeline Component

Description:

A JET Timeline is a themable, WAI-ARIA compliant component that displays a set of events in chronological order.

This component should be bound to an HTML div element, and the SVG DOM that it generates should be treated as a black box, as it is subject to change. This component should not be extended.


<div data-bind="ojComponent: {
  component: 'ojTimeline',
  minorAxis: {scale: 'weeks'},
  series: [{
    id: 's1',
    items: [{
      id: 'e1',
      title:'71st Golden Globe Awards',
      start: oj.IntlConverterUtils.dateToLocalIso(new Date('2014-01-12')),
      description:'12 Years a Slave and American Hustle win'
    }, {
      id: 'e2',
      title: 'Olympic Games 2014',
      start: oj.IntlConverterUtils.dateToLocalIso(new Date(2014-02-07)),
      end: oj.IntlConverterUtils.dateToLocalIso(new Date(2014-02-23)),
      description:'Team USA came in fourth in gold medals and second overall.'
    }]
  }],
  orientation: 'horizontal'
}"/>

Accessibility

The application is responsible for populating the shortDesc value in the component options object with meaningful descriptors when the component does not provide a default descriptor. Since component terminology for keyboard and touch shortcuts can conflict with those of the application, it is the application's responsibility to provide these shortcuts, possibly via a help popup.

Date and Time Formats

The date/time data in the Timeline plays a key role, not only in the representation of events in the order in which they occurred, but also in many other places, such as the time axis, event durations, time markers, size and position calculations for the overview locator window, etc.

The Timeline supports a simplified version of the ISO 8601 extended date/time format. The format is as follows: YYYY-MM-DDTHH:mm:ss.sssZ

Symbol Description Values Examples
-, :, .,TCharacters actually in the string. T specifies the start of a time.
YYYYYear2013-03-22
2014-02
MMMonth01 to 12
DDDay of the month01 to 31
HHHours00 to 242013-02-04T15:20Z
2013-02-10T15:20:45.300Z
mmMinutes00 to 59
ssSeconds. The seconds and milliseconds are optional if a time is specified.00 to 59
sssMilliseconds00 to 999
ZThe value in this position can be one of the following. If the value is omitted, character 'Z' should be used to specify UTC time.
  • Z indicates UTC time.
  • +hh:mm indicates that the input time is the specified offset after UTC time.
  • -hh:mm indicates that the input time is the absolute value of the specified offset before UTC time.
2013-02-04T15:20:00-07:00
2013-02-04T15:20:00+05:00
2013-02-04T15:20:00Z

The ISO format support short notations where the string must only include the date and not time, as in the following formats: YYYY, YYYY-MM, YYYY-MM-DD.

The ISO format does not support time zone names. You can use the Z position to specify an offset from UTC time. If you do not include a value in the Z position, UTC time is used. The correct format for UTC should always include character 'Z' if the offset time value is omitted. The date-parsing algorithms are browser-implementation-dependent and, for example, the date string '2013-02-27T17:00:00' will be parsed differently in Chrome vs Firefox vs IE.

You can specify midnight by using 00:00, or by using 24:00 on the previous day. The following two strings specify the same time: 2010-05-25T00:00Z and 2010-05-24T24:00Z.

Keyboard End User Information

Key Action
Tab Move focus to next component.
Shift + Tab Move focus to previous component.
UpArrow Moves focus between series in a Dual Timeline and does nothing in a Single Timeline.
DownArrow
LeftArrow Move focus and selection to previous data item (on left).
RightArrow Move focus and selection to next data item (on right).
Shift + UpArrow Move focus and multi-select previous data item.
Shift + DownArrow Move focus and multi-select next data item.
Shift + LeftArrow Move focus and multi-select previous data item (on left).
Shift + RightArrow Move focus and multi-select next data item (on right).
Ctrl + UpArrow Move focus to previous data item, without changing the current selection.
Ctrl + DownArrow Move focus to next data item, without changing the current selection.
Ctrl + LeftArrow Move focus to previous data item (on left), without changing the current selection.
Ctrl + RightArrow Move focus to next data item (on right), without changing the current selection.
Ctrl + Spacebar Multi-select data item with focus.
= or + Zoom in one level if zooming is enabled.
- or _ Zoom out one level if zooming is enabled.
PageUp Pan up if scrolling is enabled.
PageDown Pan down if scrolling is enabled.
Shift + PageUp Pan left in left-to-right locales. Pan right in right-to-left locales.
Shift + PageDown Pan right in left-to-right locales. Pan left in right-to-left locales.

Touch End User Information

Target Gesture Action
Timeline Item Tap Select when selectionMode is enabled.
Timeline Panel Drag Paning: navigate forward and backward in time in horizontal/vertical orientation.
Pinch-Close/Spread-Open Zoom In/Out.
Zoom Control Tap on "+" element Zoom In.
Tap on "-" element Zoom Out.
Overview Press on right/left side of window & Hold & Drag in right of left direction Zoom In/Out (resize overview window).
Press & Hold on the body of window & Drag in right of left direction Pan (move overview window).

Performance

Animation

Animation should only be enabled for visualizations of small to medium data sets.

Data Set Size

As a rule of thumb, it's recommended that applications only set usable data densities on the timeline. For example, applications should limit the number of overlapping items rendered beyond the height of the timeline. This can be achieved by increasing the size of the timeline, decreasing the axis scale, or providing external filters to reduce the amount of data rendered at any given time. While there are several optimizations within the timeline to deal with large data sets, it's always more efficient to reduce the data set size as early as possible. Future optimizations will focus on improving end user experience as well as developer productivity for common use cases.

Timeline Span

It's recommended that applications limit the number of time intervals that are rendered by the timeline. For example, a timeline spanning one year with a scale of hours will display (365 * 24) 8,760 intervals. Rendering this many intervals can cause severe performance degradation when interacting with the component (scrolling and zooming) regardless of the number of items present.

Initializer

.ojTimeline()

Creates a JET Timeline.
Source:
Examples

Initialize the Timeline with some options:

$(".selector").ojTimeline({orientation: 'vertical'});

Initialize the Timeline via the JET ojComponent binding:

<div data-bind="ojComponent: {component: 'ojTimeline'}">

Options

animationOnDataChange :string

Defines the animation that is applied on data changes.
Supported Values:
Name Type
"auto" string
"none" string
Default Value:
  • "none"
Source:

animationOnDisplay :string

Defines the animation that is shown on initial display.
Supported Values:
Name Type
"auto" string
"none" string
Default Value:
  • "none"
Source:

contextMenu :Element|Array.<Element>|string|jQuery|NodeList

Identifies the JET Menu that the component should launch as a context menu on right-click, Shift-F10, Press & Hold, or component-specific gesture. If specified, the browser's native context menu will be replaced by the specified JET Menu.

The value can be an HTML element, JQ selector, JQ object, NodeList, or array of elements. In all cases, the first indicated element is used.

To specify a JET context menu on a DOM element that is not a JET component, see the ojContextMenu binding.

To make the page semantically accurate from the outset, applications are encouraged to specify the context menu via the standard HTML5 syntax shown in the below example. When the component is initialized, the context menu thus specified will be set on the component.

There is no restriction on the order in which the JET Menu and the referencing component are initialized. However, when specifying the Menu via the HTML attribute, the referenced DOM element must be in the document at the time that the referencing component is initialized.

After create time, the contextMenu option should be set via this API, not by setting the DOM attribute.

The application can register a listener for the Menu's beforeOpen event. The listener can cancel the launch via event.preventDefault(), or it can customize the menu contents by editing the menu DOM directly, and then calling refresh() on the Menu.

To help determine whether it's appropriate to cancel the launch or customize the menu, the beforeOpen listener can use component API's to determine which table cell, chart item, etc., is the target of the context menu. See the JSDoc and demos of the individual components for details. Keep in mind that any such logic must work whether the context menu was launched via right-click, Shift-F10, Press & Hold, or component-specific touch gesture.

Default Value:
  • null
Inherited From:
Source:
Examples

Initialize a JET component with a context menu:

// via recommended HTML5 syntax:
<div id="myComponent" contextmenu="myMenu" data-bind="ojComponent: { ... }>

// via JET initializer (less preferred) :
// Foo is the component, e.g., InputText, InputNumber, Select, etc.
$( ".selector" ).ojFoo({ "contextMenu": "#myMenu" });

Get or set the contextMenu option, after initialization:

// getter
// Foo is the component, e.g., InputText, InputNumber, Select, etc.
var menu = $( ".selector" ).ojFoo( "option", "contextMenu" );

// setter
// Foo is the component, e.g., InputText, InputNumber, Select, etc.
$( ".selector" ).ojFoo( "option", "contextMenu", ".my-marker-class" );

Set a JET context menu on an ordinary HTML element:

<a href="#" id="myAnchor" contextmenu="myMenu" data-bind="ojContextMenu: {}">Some text

end :string|number|Date

The end time of the timeline. This is required in order for the timeline to properly render.
Default Value:
  • null
Deprecated:
  • The Date type is deprecated in 2.1.0. The number type is deprecated in 3.0.0.
    Source:

    majorAxis :object

    An object with the following properties, used to define a timeline axis. If not specified, no axis labels will be shown above the minorAxis or in the overview.
    Default Value:
    • null
    Source:

    majorAxis.converter :object

    The converter (an object literal or instance that duck types oj.Converter) used to format the labels of the majorAxis. If not specified, the default converter is used. If a single converter is specified, it will be used for all 'scale' values. Otherwise, an object whose keys are 'scale' values that map to the converter instances is expected. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
    Default Value:
    • null
    Source:

    majorAxis.converter.days :object

    The converter (an object literal or instance that duck types oj.Converter) used for the 'days' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
    Default Value:
    • null
    Source:

    majorAxis.converter.default :object

    The default converter (an object literal or instance that duck types oj.Converter) to use for all 'scale' values that do not otherwise have a converter object provided. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
    Default Value:
    • null
    Source:

    majorAxis.converter.hours :object

    The converter (an object literal or instance that duck types oj.Converter) used for the 'hours' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
    Default Value:
    • null
    Source:

    majorAxis.converter.minutes :object

    The converter (an object literal or instance that duck types oj.Converter) used for the 'minutes' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
    Default Value:
    • null
    Source:

    majorAxis.converter.months :object

    The converter (an object literal or instance that duck types oj.Converter) used for the 'months' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
    Default Value:
    • null
    Source:

    majorAxis.converter.quarters :object

    The converter (an object literal or instance that duck types oj.Converter) used for the 'quarters' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
    Default Value:
    • null
    Source:

    majorAxis.converter.seconds :object

    The converter (an object literal or instance that duck types oj.Converter) used for the 'seconds' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
    Default Value:
    • null
    Source:

    majorAxis.converter.weeks :object

    The converter (an object literal or instance that duck types oj.Converter) used for the 'weeks' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
    Default Value:
    • null
    Source:

    majorAxis.converter.years :object

    The converter (an object literal or instance that duck types oj.Converter) used for the 'years' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
    Default Value:
    • null
    Source:

    majorAxis.scale :string

    The time scale used for the majorAxis. If not specified, no axis labels will be shown above the minorAxis or in the overview.
    Supported Values:
    Name Type
    "seconds" string
    "minutes" string
    "hours" string
    "days" string
    "weeks" string
    "months" string
    "quarters" string
    "years" string
    Default Value:
    • null
    Source:

    majorAxis.style :string

    The CSS style string defining any additional styling of the axis. If not specified, no additional styling will be applied.
    Default Value:
    • null
    Deprecated:
    • This attribute is deprecated, use the svgStyle attribute instead.
      Source:

      majorAxis.svgStyle :object

      The CSS style defining any additional styling of the axis. If not specified, no additional styling will be applied.
      Default Value:
      • null
      Source:

      minorAxis :object

      An object with the following properties, used to define a timeline axis. This is required in order for the timeline to properly render.
      Default Value:
      • null
      Source:

      minorAxis.converter :object

      The converter (an object literal or instance that duck types oj.Converter) used to format the labels of the minorAxis. If not specified, the default converter is used. If a single converter is specified, it will be used for all 'scale' values. Otherwise, an object whose keys are 'scale' values that map to the converter instances is expected. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
      Default Value:
      • null
      Source:

      minorAxis.converter.days :object

      The converter (an object literal or instance that duck types oj.Converter) used for the 'days' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
      Default Value:
      • null
      Source:

      minorAxis.converter.default :object

      The default converter (an object literal or instance that duck types oj.Converter) to use for all 'scale' values that do not otherwise have a converter object provided. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
      Default Value:
      • null
      Source:

      minorAxis.converter.hours :object

      The converter (an object literal or instance that duck types oj.Converter) used for the 'hours' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
      Default Value:
      • null
      Source:

      minorAxis.converter.minutes :object

      The converter (an object literal or instance that duck types oj.Converter) used for the 'minutes' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
      Default Value:
      • null
      Source:

      minorAxis.converter.months :object

      The converter (an object literal or instance that duck types oj.Converter) used for the 'months' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
      Default Value:
      • null
      Source:

      minorAxis.converter.quarters :object

      The converter (an object literal or instance that duck types oj.Converter) used for the 'quarters' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
      Default Value:
      • null
      Source:

      minorAxis.converter.seconds :object

      The converter (an object literal or instance that duck types oj.Converter) used for the 'seconds' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
      Default Value:
      • null
      Source:

      minorAxis.converter.weeks :object

      The converter (an object literal or instance that duck types oj.Converter) used for the 'weeks' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
      Default Value:
      • null
      Source:

      minorAxis.converter.years :object

      The converter (an object literal or instance that duck types oj.Converter) used for the 'years' scale. If not specified, the default converter will be used for this scale. See oj.DateTimeConverterFactory for details on creating built-in datetime converters.
      Default Value:
      • null
      Source:

      minorAxis.scale :string

      The time scale used for the minorAxis. This is required in order for the timeline to properly render.
      Supported Values:
      Name Type
      "seconds" string
      "minutes" string
      "hours" string
      "days" string
      "weeks" string
      "months" string
      "quarters" string
      "years" string
      Default Value:
      • null
      Source:

      minorAxis.style :string

      The CSS style string defining any additional styling of the axis. If not specified, no additional styling will be applied.
      Default Value:
      • null
      Deprecated:
      • This attribute is deprecated, use the svgStyle attribute instead.
        Source:

        minorAxis.svgStyle :object

        The CSS style defining any additional styling of the axis. If not specified, no additional styling will be applied.
        Default Value:
        • null
        Source:

        minorAxis.zoomOrder :Array.<string>

        An array of strings containing the names of scales used for zooming from longest to shortest. If not specified, the 'scale' specified on the minorAxis will be used at all zoom levels.
        Default Value:
        • null
        Source:

        orientation :string

        The orientation of the component.
        Supported Values:
        Name Type
        "vertical" string
        "horizontal" string
        Default Value:
        • "horizontal"
        Source:

        overview :object

        An object with the following properties, used to define a timeline overview. If not specified, no overview will be shown.
        Default Value:
        • null
        Source:

        overview.rendered :string

        Specifies whether the overview scrollbar is rendered.
        Supported Values:
        Name Type
        "on" string
        "off" string
        Default Value:
        • "off"
        Source:

        overview.style :string

        The CSS style string defining any additional styling of the overview. If not specified, no additional styling will be applied.
        Default Value:
        • null
        Deprecated:
        • This attribute is deprecated, use the svgStyle attribute instead.
          Source:

          overview.svgStyle :object

          The CSS style defining any additional styling of the overview. If not specified, no additional styling will be applied.
          Default Value:
          • null
          Source:

          referenceObjects :Array.<object>

          The array of reference objects associated with the timeline. For each reference object, a line is rendered at the specified value. Currently only the first reference object in the array is supported. Any additional objects supplied in the array will be ignored.
          Default Value:
          • null
          Source:

          referenceObjects[].value :string|number|Date

          The value of this reference object. If not specified, no reference object will be shown.
          Default Value:
          • null
          Deprecated:
          • The Date type is deprecated in 2.1.0. The number type is deprecated in 3.0.0.
            Source:

            rootAttributes :Object

            Attributes specified here will be set on the component's root DOM element at creation time. This is particularly useful for components like Dialog that wrap themselves in a new root element at creation time.

            The supported attributes are id, which overwrites any existing value, and class and style, which are appended to the current class and style, if any.

            Setting this option after component creation has no effect. At that time, the root element already exists, and can be accessed directly via the widget method, per the second example below.

            Default Value:
            • null
            Inherited From:
            Source:
            Examples

            Initialize a JET component, specifying a set of attributes to be set on the component's root DOM element:

            // Foo is the component, e.g., Menu, Button, InputText, InputNumber, Select, etc.
            $( ".selector" ).ojFoo({ "rootAttributes": {
              "id": "myId",
              "style": "max-width:100%; color:blue;",
              "class": "my-class"
            }});

            After initialization, rootAttributes should not be used. It is not needed at that time, as attributes of the root DOM element can simply be set directly, using widget:

            // Foo is the component, e.g., Menu, Button, InputText, InputNumber, Select, etc.
            $( ".selector" ).ojFoo( "widget" ).css( "height", "100px" );
            $( ".selector" ).ojFoo( "widget" ).addClass( "my-class" );

            selection :Array.<string>

            An array of strings containing the ids of the initially selected items.
            Default Value:
            • null
            Source:

            selectionMode :string

            The type of selection behavior that is enabled on the timeline. If 'single' is specified, only a single item across all series can be selected at once. If 'multiple', any number of items across all series can be selected at once. Otherwise, selection is disabled.
            Supported Values:
            Name Type
            "single" string
            "multiple" string
            "none" string
            Default Value:
            • "none"
            Source:

            series :Array.<object>|Promise|function<>

            An array of objects with the following properties, used to define a timeline series. Also accepts a Promise or callback function for deferred data rendering. The function should return one of the following:
            • Promise: A Promise that will resolve with an array of data items. No data will be rendered if the Promise is rejected.
            • Array: An array of data items.
            Default Value:
            • null
            Deprecated:
            • The function type is deprecated in 3.0.0.
              Source:

              series[].emptyText :string

              The text of an empty timeline series.
              Default Value:
              • null
              Source:

              series[].id :string

              The identifier for the timeline series.
              Default Value:
              • null
              Source:

              series[].itemLayout :string

              The direction in which items are laid out when in a horizontal orientation. This attribute is ignored when in a vertical orientation.
              Supported Values:
              Name Type
              "bottomToTop" string
              "topToBottom" string
              "auto" string
              Default Value:
              • "auto"
              Source:

              series[].items :Array.<object>

              An array of objects with the following properties, used to define a timeline item. If not specified, no data will be shown in this series.
              Default Value:
              • null
              Source:

              series[].items[].description :string

              The description text displayed on the timeline item. If not specified, no description will be shown.
              Default Value:
              • null
              Source:

              series[].items[].durationFillColor :string

              The color applied to the duration bar of the timeline item. If not specified, this will be determined by the color ramp of the series.
              Default Value:
              • null
              Source:

              series[].items[].end :string|number|Date

              The end time of this timeline item. If not specified, no duration bar will be shown.
              Default Value:
              • null
              Deprecated:
              • The Date type is deprecated in 2.1.0. The number type is deprecated in 3.0.0.
                Source:

                series[].items[].id :string

                The identifier for the timeline item. This must be unique across all items in the timeline, and is required in order for the timeline to properly render.
                Default Value:
                • null
                Source:

                series[].items[].start :string|number|Date

                The start time of this timeline item. This is required in order for the timeline item to properly render.
                Default Value:
                • null
                Deprecated:
                • The Date type is deprecated in 2.1.0. The number type is deprecated in 3.0.0.
                  Source:

                  series[].items[].style :string

                  The CSS style string defining any additional styling of the item. If not specified, no additional styling will be applied.
                  Default Value:
                  • null
                  Deprecated:
                  • This attribute is deprecated, use the svgStyle attribute instead.
                    Source:

                    series[].items[].svgStyle :object

                    The CSS style defining any additional styling of the item. If not specified, no additional styling will be applied.
                    Default Value:
                    • null
                    Source:

                    series[].items[].thumbnail :string

                    An optional URI specifying the location of an image resource to be displayed on the item. The image will be rendered at 32px x 32px in size. If not specified, no thumbnail will be shown.
                    Default Value:
                    • null
                    Source:

                    series[].items[].title :string

                    The title text displayed on the timeline item. If not specified, no title will be shown.
                    Default Value:
                    • null
                    Source:

                    series[].label :string

                    The label displayed on the timeline series. In not specified, no label will be shown.
                    Default Value:
                    • null
                    Source:

                    series[].style :string

                    The CSS style string defining any additional styling of the series. If not specified, no additional styling will be applied.
                    Default Value:
                    • null
                    Deprecated:
                    • This attribute is deprecated, use the svgStyle attribute instead.
                      Source:

                      series[].svgStyle :object

                      The CSS style defining any additional styling of the series. If not specified, no additional styling will be applied.
                      Default Value:
                      • null
                      Deprecated:
                      • This attribute is deprecated, use the svgStyle attribute instead.
                        Source:

                        start :string|number|Date

                        The start time of the timeline. This is required in order for the timeline to properly render.
                        Default Value:
                        • null
                        Deprecated:
                        • The Date type is deprecated in 2.1.0. The number type is deprecated in 3.0.0.
                          Source:

                          styleDefaults :object

                          An object with the following properties, used to define default styling for the timeline.
                          Default Value:
                          • null
                          Source:

                          styleDefaults.animationDuration :number

                          The duration of the animations, in milliseconds. Also accepts CSS strings such as 1s and 1000ms. For data change animations with multiple stages, this attribute defines the duration of each stage. For example, if an animation contains two stages, the total duration will be two times this attribute's value.
                          Default Value:
                          • null
                          Source:

                          styleDefaults.borderColor :string

                          The border color of the timeline.
                          Default Value:
                          • null
                          Source:

                          styleDefaults.item :object

                          An object with the following properties, used to define the default styling for the timeline item.
                          Default Value:
                          • null
                          Source:

                          styleDefaults.item.backgroundColor :string

                          The background color of the timeline items.
                          Default Value:
                          • null
                          Source:

                          styleDefaults.item.borderColor :string

                          The border color of the timeline items.
                          Default Value:
                          • null
                          Source:

                          styleDefaults.item.descriptionStyle :object|string

                          The CSS style defining the style of the timeline item description text.
                          Default Value:
                          • null
                          Deprecated:
                          • The string type is deprecated in 3.0.0.
                            Source:

                            styleDefaults.item.hoverBackgroundColor :string

                            The background color of the highlighted timeline items.
                            Default Value:
                            • null
                            Source:

                            styleDefaults.item.hoverBorderColor :string

                            The border color of the highlighted timeline items.
                            Default Value:
                            • null
                            Source:

                            styleDefaults.item.selectedBackgroundColor :string

                            The background color of the selected timeline items.
                            Default Value:
                            • null
                            Source:

                            styleDefaults.item.selectedBorderColor :string

                            The border color of the selected timeline items.
                            Default Value:
                            • null
                            Source:

                            styleDefaults.item.titleStyle :object|string

                            The CSS style defining the style of the timeline item title text.
                            Default Value:
                            • null
                            Deprecated:
                            • The string type is deprecated in 3.0.0.
                              Source:

                              styleDefaults.majorAxis :object

                              An object with the following properties, used to define the default styling for the major time axis.
                              Default Value:
                              • null
                              Source:

                              styleDefaults.majorAxis.labelStyle :object|string

                              The CSS style defining the style of the major time axis label text.
                              Default Value:
                              • null
                              Deprecated:
                              • The string type is deprecated in 3.0.0.
                                Source:

                                styleDefaults.majorAxis.separatorColor :string

                                The color of the major time axis separators.
                                Default Value:
                                • null
                                Source:

                                styleDefaults.minorAxis :object

                                An object with the following properties, used to define the default styling for the time axis.
                                Default Value:
                                • null
                                Source:

                                styleDefaults.minorAxis.backgroundColor :string

                                The background color of the time axis.
                                Default Value:
                                • null
                                Source:

                                styleDefaults.minorAxis.borderColor :string

                                The border color of the time axis.
                                Default Value:
                                • null
                                Source:

                                styleDefaults.minorAxis.labelStyle :object|string

                                The CSS style defining the style of the time axis label text.
                                Default Value:
                                • null
                                Deprecated:
                                • The string type is deprecated in 3.0.0.
                                  Source:

                                  styleDefaults.minorAxis.separatorColor :string

                                  The color of the time axis separators.
                                  Default Value:
                                  • null
                                  Source:

                                  styleDefaults.overview :object

                                  An object with the following properties, used to define the default styling for the timeline overview.
                                  Default Value:
                                  • null
                                  Source:

                                  styleDefaults.overview.backgroundColor :string

                                  The background color of the timeline overview.
                                  Default Value:
                                  • null
                                  Source:

                                  styleDefaults.overview.labelStyle :object|string

                                  The CSS style defining the style of the timeline overview label text.
                                  Default Value:
                                  • null
                                  Deprecated:
                                  • The string type is deprecated in 3.0.0.
                                    Source:

                                    styleDefaults.overview.window :object

                                    An object with the following properties, used to define the default styling for the timeline overview window.
                                    Default Value:
                                    • null
                                    Source:

                                    styleDefaults.overview.window.backgroundColor :string

                                    The background color of the timeline overview window.
                                    Default Value:
                                    • null
                                    Source:

                                    styleDefaults.overview.window.borderColor :string

                                    The border color of the timeline overview window.
                                    Default Value:
                                    • null
                                    Source:

                                    styleDefaults.referenceObject :object

                                    An object with the following properties, used to define the default styling for the reference objects.
                                    Default Value:
                                    • null
                                    Source:

                                    styleDefaults.referenceObject.color :string

                                    The color of the reference objects.
                                    Default Value:
                                    • null
                                    Source:

                                    styleDefaults.series :object

                                    An object with the following properties, used to define the default styling for the timeline series.
                                    Default Value:
                                    • null
                                    Source:

                                    styleDefaults.series.backgroundColor :string

                                    The background color of the series.
                                    Default Value:
                                    • null
                                    Source:

                                    styleDefaults.series.colors :Array.<string>

                                    The array defining the default color ramp for the series items.
                                    Default Value:
                                    • null
                                    Source:

                                    styleDefaults.series.emptyTextStyle :object|string

                                    The CSS style defining the style of the series empty text.
                                    Default Value:
                                    • null
                                    Deprecated:
                                    • The string type is deprecated in 3.0.0.
                                      Source:

                                      styleDefaults.series.labelStyle :object|string

                                      The CSS style defining the style of the series label text.
                                      Default Value:
                                      • null
                                      Deprecated:
                                      • The string type is deprecated in 3.0.0.
                                        Source:

                                        trackResize :string

                                        Defines whether the component will automatically render in response to changes in size. If set to off, then the application is responsible for calling refresh to render the component at the new size.
                                        Supported Values:
                                        Name Type
                                        "on" string
                                        "off" string
                                        Default Value:
                                        • "on"
                                        Inherited From:
                                        Source:

                                        translations :Object

                                        A collection of translated resources from the translation bundle, or null if this component has no resources. Resources may be accessed and overridden individually or collectively, as seen in the examples.

                                        If this component has (or inherits) translations, their documentation immediately follows this doc entry.

                                        Default Value:
                                        • an object containing all resources relevant to the component and all its superclasses, or null if none
                                        Inherited From:
                                        Source:
                                        Examples

                                        Initialize the component, overriding some translated resources. This syntax leaves the other translations intact at create time, but not if called after create time:

                                        // Foo is InputDate, InputNumber, etc.
                                        $( ".selector" ).ojFoo({ "translations": { someKey: "someValue",
                                                                                   someOtherKey: "someOtherValue" } });

                                        Get or set the translations option, after initialization:

                                        // Get one.  (Foo is InputDate, InputNumber, etc.)
                                        var value = $( ".selector" ).ojFoo( "option", "translations.someResourceKey" );
                                        
                                        // Get all.  (Foo is InputDate, InputNumber, etc.)
                                        var values = $( ".selector" ).ojFoo( "option", "translations" );
                                        
                                        // Set one, leaving the others intact.  (Foo is InputDate, InputNumber, etc.)
                                        $( ".selector" ).ojFoo( "option", "translations.someResourceKey", "someValue" );
                                        
                                        // Set many.  Any existing resource keys not listed are lost.  (Foo is InputDate, InputNumber, etc.)
                                        $( ".selector" ).ojFoo( "option", "translations", { someKey: "someValue",
                                                                                            someOtherKey: "someOtherValue" } );

                                        translations.accessibleItemDesc :string

                                        Provides properties to customize the screen reader text describing an item's description text.

                                        Default Value:
                                        • "Description is {0}."
                                        Since:
                                        • 3.0.0
                                        Source:

                                        translations.accessibleItemEnd :string

                                        Provides properties to customize the screen reader text describing an item's end time.

                                        Default Value:
                                        • "End time is {0}."
                                        Since:
                                        • 3.0.0
                                        Source:

                                        translations.accessibleItemStart :string

                                        Provides properties to customize the screen reader text describing an item's start time.

                                        Default Value:
                                        • "Start time is {0}."
                                        Since:
                                        • 3.0.0
                                        Source:

                                        translations.accessibleItemTitle :string

                                        Provides properties to customize the screen reader text describing an item's title text.

                                        Default Value:
                                        • "Title is {0}."
                                        Since:
                                        • 3.0.0
                                        Source:

                                        translations.componentName :string

                                        Used to describe the data visualization type for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Timeline"
                                        Source:

                                        translations.labelAndValue :string

                                        Used to display a label and its value.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "{0}: {1}"
                                        Inherited From:
                                        Source:

                                        translations.labelClearSelection :string

                                        Text shown for clearing multiple selection on touch devices.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Clear Selection"
                                        Inherited From:
                                        Source:

                                        translations.labelCountWithTotal :string

                                        Used to display a count out of a total.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "{0} of {1}"
                                        Inherited From:
                                        Source:

                                        translations.labelDataVisualization :string

                                        Label for data visualizations used for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Data Visualization"
                                        Inherited From:
                                        Source:

                                        translations.labelInvalidData :string

                                        Text shown when the component receives invalid data.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Invalid data"
                                        Inherited From:
                                        Source:

                                        translations.labelNoData :string

                                        Text shown when the component receives no data.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "No data to display"
                                        Inherited From:
                                        Source:

                                        translations.labelSeries :string

                                        Used for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Series"
                                        Source:

                                        translations.stateCollapsed :string

                                        Used to describe the collapsed state for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Collapsed"
                                        Inherited From:
                                        Source:

                                        translations.stateDrillable :string

                                        Used to describe a drillable object for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Drillable"
                                        Inherited From:
                                        Source:

                                        translations.stateExpanded :string

                                        Used to describe the expanded state for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Expanded"
                                        Inherited From:
                                        Source:

                                        translations.stateHidden :string

                                        Used to describe the hidden state for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Hidden"
                                        Inherited From:
                                        Source:

                                        translations.stateIsolated :string

                                        Used to describe the isolated state for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Isolated"
                                        Inherited From:
                                        Source:

                                        translations.stateMaximized :string

                                        Used to describe the maximized state for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Maximized"
                                        Inherited From:
                                        Source:

                                        translations.stateMinimized :string

                                        Used to describe the minimized state for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Minimized"
                                        Inherited From:
                                        Source:

                                        translations.stateSelected :string

                                        Used to describe the selected state for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Selected"
                                        Inherited From:
                                        Source:

                                        translations.stateUnselected :string

                                        Used to describe the unselected state for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Unselected"
                                        Inherited From:
                                        Source:

                                        translations.stateVisible :string

                                        Used to describe the visible state for accessibility.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Visible"
                                        Inherited From:
                                        Source:

                                        translations.tooltipZoomIn :string

                                        Used for the zoom in tooltip.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Zoom In"
                                        Source:

                                        translations.tooltipZoomOut :string

                                        Used for the zoom out tooltip.

                                        See the translations option for usage examples.

                                        Default Value:
                                        • "Zoom Out"
                                        Source:

                                        viewportEnd :string|number|Date

                                        The end time of the timeline's viewport. If not specified, this will default to a value determined by the initial 'scale' of the minorAxis and the width of the timeline.
                                        Default Value:
                                        • null
                                        Deprecated:
                                        • The Date type is deprecated in 2.1.0. The number type is deprecated in 3.0.0.
                                          Source:

                                          viewportStart :string|number|Date

                                          The start time of the timeline's viewport. If not specified, this will default to a value determined by the initial 'scale' of the minorAxis and the width of the timeline.
                                          Default Value:
                                          • null
                                          Deprecated:
                                          • The Date type is deprecated in 2.1.0. The number type is deprecated in 3.0.0.
                                            Source:

                                            Context Objects

                                            Each context object contains, at minimum, a subId property, whose value is a string that identifies a particular DOM node in this component. It can have additional properties to further specify the desired node. See getContextByNode for more details.

                                            Properties:
                                            Name Type Description
                                            subId string Sub-id string to identify a particular dom node.

                                            Following are the valid subIds:

                                            oj-timeline-item

                                            Context for timeline series items indexed by series and item indices.

                                            Properties:
                                            Name Type
                                            seriesIndex number
                                            itemIndex number
                                            Source:

                                            Sub-ID's

                                            Each subId locator object contains, at minimum, a subId property, whose value is a string that identifies a particular DOM node in this component. It can have additional properties to further specify the desired node. See getNodeBySubId and getSubIdByNode methods for more details.

                                            Properties:
                                            Name Type Description
                                            subId string Sub-id string to identify a particular dom node.

                                            Following are the valid subIds:

                                            oj-timeline-item

                                            Sub-ID for timeline series items indexed by series and item indices.

                                            Properties:
                                            Name Type
                                            seriesIndex number
                                            itemIndex number
                                            Source:
                                            Example

                                            Gets the second item from the first series:

                                            var nodes = $( ".selector" ).ojTimeline( "getNodeBySubId", {'subId': 'oj-timeline-item', 'seriesIndex': 0, 'itemIndex': 1} );

                                            Events

                                            destroy

                                            Triggered before the component is destroyed. This event cannot be canceled; the component will always be destroyed regardless.

                                            Inherited From:
                                            Source:
                                            Examples

                                            Initialize component with the destroy callback

                                            // Foo is Button, InputText, etc.
                                            $(".selector").ojFoo({
                                              'destroy': function (event, data) {}
                                            });

                                            Bind an event listener to the destroy event

                                            $(".selector").on({
                                              'ojdestroy': function (event, data) {
                                                  // verify that the component firing the event is a component of interest
                                                  if ($(event.target).is(".mySelector")) {
                                                      window.console.log("The DOM node id for the destroyed component is : %s", event.target.id);
                                                  }
                                              };
                                            });

                                            optionChange

                                            Fired whenever a supported component option changes, whether due to user interaction or programmatic intervention. If the new value is the same as the previous value, no event will be fired. The event listener will receive two parameters described below:
                                            Properties:
                                            Name Type Description
                                            event Event jQuery event object
                                            ui Object event payload
                                            Properties
                                            Name Type Argument Description
                                            option string the name of the option that changed.
                                            previousValue Object an Object holding the previous value of the option. When previousValue is not a primitive type, i.e., is an Object, it may hold the same value as the value property.
                                            value Object an Object holding the current value of the option.
                                            subproperty Object <nullable>
                                            an Object holding information about the subproperty that changed.
                                            Properties
                                            Name Type Description
                                            path string the subproperty path that changed.
                                            previousValue Object an Object holding the previous value of the subproperty.
                                            value Object an Object holding the current value of the subproperty.
                                            optionMetadata Object information about the option that changed
                                            Properties
                                            Name Type Description
                                            writeback string "shouldWrite" or "shouldNotWrite". For use by the JET writeback mechanism; 'shouldWrite' indicates that the value should be written to the observable.
                                            Inherited From:
                                            Source:
                                            Examples

                                            Initialize component with the optionChange callback

                                            // Foo is Button, InputText, etc.
                                            $(".selector").ojFoo({
                                              'optionChange': function (event, ui) {}
                                            });

                                            Bind an event listener to the ojoptionchange event

                                            $(".selector").on({
                                              'ojoptionchange': function (event, ui) {
                                                  // verify that the component firing the event is a component of interest
                                                  if ($(event.target).is(".mySelector")) {
                                                      window.console.log("option that changed is: " + ui['option']);
                                                  }
                                              };
                                            });

                                            viewportChange

                                            Triggered after the viewport is changed due to a zoom or scroll operation.
                                            Properties:
                                            Name Type Description
                                            ui Object event payload
                                            Properties
                                            Name Type Description
                                            viewportStart string the start of the new viewport on a timeline
                                            viewportEnd string the end of the new viewport on a timeline
                                            minorAxisScale string the time scale of the minorAxis
                                            Source:
                                            Examples

                                            Initialize the component with the viewportChange callback specified:

                                            $(".selector").ojTimeline({
                                              "viewportChange": function(event, ui){}
                                            });

                                            Bind an event listener to the ojviewportchange event:

                                            $(".selector").on("ojviewportchange", function(event, ui){});

                                            Methods

                                            getContextByNode(node) → {Object|null}

                                            Returns an object with context for the given child DOM node. This will always contain the subid for the node, defined as the 'subId' property on the context object. Additional component specific information may also be included. For more details on returned objects, see context objects.
                                            Parameters:
                                            Name Type Description
                                            node Element The child DOM node
                                            Inherited From:
                                            Source:
                                            Returns:
                                            The context for the DOM node, or null when none is found.
                                            Type
                                            Object | null
                                            Example
                                             // Foo is ojInputNumber, ojInputDate, etc.
                                            // Returns {'subId': oj-foo-subid, 'property1': componentSpecificProperty, ...}
                                            var context = $( ".selector" ).ojFoo( "getContextByNode", nodeInsideComponent );

                                            getNodeBySubId(locator) → {Element|null}

                                            Returns the component DOM node indicated by the locator parameter.

                                            If the locator or its subId is null, then this method returns the element on which this component was initialized.

                                            If a non-null subId is provided but no corresponding node can be located, then this method returns null.

                                            This method is intended for use in test automation only, and should not be used in a production environment.

                                            Parameters:
                                            Name Type Description
                                            locator Object An Object containing, at minimum, a subId property, whose value is a string that identifies a particular DOM node in this component.

                                            If this component has (or inherits) any subIds, then they are documented in the Sub-ID's section of this document.

                                            Some components may support additional fields of the locator Object, to further specify the desired node.

                                            Inherited From:
                                            Source:
                                            Returns:
                                            The DOM node located by the locator, or null if none is found.
                                            Type
                                            Element | null
                                            Example

                                            Get the node for a certain subId:

                                            // Foo is ojInputNumber, ojInputDate, etc.
                                            var node = $( ".selector" ).ojFoo( "getNodeBySubId", {'subId': 'oj-some-sub-id'} );

                                            getSubIdByNode(node) → {Object|null}

                                            Returns the subId string for the given DOM node in this component. For details, see getNodeBySubId and the Sub-ID's section of this document.

                                            This method is intended for use in test automation only, and should not be used in a production environment.

                                            Parameters:
                                            Name Type Description
                                            node Element DOM node in this component
                                            Inherited From:
                                            Source:
                                            Returns:
                                            The subId for the DOM node, or null if none is found.
                                            Type
                                            Object | null
                                            Example

                                            Get the subId for a certain DOM node:

                                            // Foo is ojInputNumber, ojInputDate, etc.
                                            var locator = $( ".selector" ).ojFoo( "getSubIdByNode", nodeInsideComponent );

                                            option(optionName, value) → {Object|undefined}

                                            This method has several overloads, which get and set component options and their fields. The functionality is unchanged from that provided by JQUI. See the examples for details on each overload.

                                            Parameters:
                                            Name Type Argument Description
                                            optionName string | Object <optional>
                                            the option name (string, first two overloads), or the map (Object, last overload). Omitted in the third overload.
                                            value Object <optional>
                                            a value to set for the option. Second overload only.
                                            Inherited From:
                                            Source:
                                            Returns:
                                            The getter overloads return the retrieved value(s). When called via the public jQuery syntax, the setter overloads return the object on which they were called, to facilitate method chaining.
                                            Type
                                            Object | undefined
                                            Examples

                                            First overload: get one option:

                                            This overload accepts a (possibly dot-separated) optionName param as a string, and returns the current value of that option.

                                            var isDisabled = $( ".selector" ).ojFoo( "option", "disabled" ); // Foo is Button, Menu, etc.
                                            
                                            // For object-valued options, dot notation can be used to get the value of a field or nested field.
                                            var startIcon = $( ".selector" ).ojButton( "option", "icons.start" ); // icons is object with "start" field

                                            Second overload: set one option:

                                            This overload accepts two params: a (possibly dot-separated) optionName string, and a new value to which that option will be set.

                                            $( ".selector" ).ojFoo( "option", "disabled", true ); // Foo is Button, Menu, etc.
                                            
                                            // For object-valued options, dot notation can be used to set the value
                                            // of a field or nested field, without altering the rest of the object.
                                            $( ".selector" ).ojButton( "option", "icons.start", myStartIcon ); // icons is object with "start" field

                                            Third overload: get all options:

                                            This overload accepts no params, and returns a map of key/value pairs representing all the component options and their values.

                                            var options = $( ".selector" ).ojFoo( "option" ); // Foo is Button, Menu, etc.

                                            Fourth overload: set one or more options:

                                            This overload accepts a single map of option-value pairs to set on the component. Unlike the first two overloads, dot notation cannot be used.

                                            $( ".selector" ).ojFoo( "option", { disabled: true, bar: 42 } ); // Foo is Button, Menu, etc.

                                            refresh()

                                            Refreshes the component.

                                            Inherited From:
                                            Source:
                                            Returns:
                                            When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining.

                                            whenReady() → {Promise}

                                            Returns a promise that is resolved when the component is finished rendering. This can be used to determine when it is okay to call automation and other APIs on the component.
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            Promise

                                            Non-public Methods

                                            Note: Extending JET components is not currently supported. Thus, non-public methods are for internal use only.

                                            <protected> _AddActiveable(options)

                                            Add touch and mouse listeners to toggle oj-active class
                                            Parameters:
                                            Name Type Description
                                            options !Object | !jQuery This parameter can either be the element (convenience syntax for callers needing to specify only the element(s) that would otherwise have been passed as options.element) or an object supporting the following fields:
                                            Properties
                                            Name Type Argument Description
                                            element jQuery The element(s) to receive the oj-active class on active Required if afterToggle is specified.
                                            afterToggle function(string) <nullable>
                                            Optional callback function called each time the active classes have been toggled, after the toggle. The event.type string is passed and indicates whether the classes were added or removed. The active classes are added on "touchstart" or "mousedown" or "mouseenter" and the active classes are removed on "touchend" or "touchcancel" or "mouseup" or "mouseleave". Components with consistency requirements, such as "oj-default must be applied iff no state classes such as oj-active are applied," can enforce those rules in this callback.
                                            Inherited From:
                                            Source:
                                            See:

                                            <protected> _AddHoverable(options)

                                            Add mouse listners to toggle oj-hover class
                                            Parameters:
                                            Name Type Description
                                            options !Object | !jQuery This param can either be the element (convenience syntax for callers needing to specify only the element(s) that would otherwise have been passed as options.element) or an object supporting the following fields:
                                            Properties
                                            Name Type Argument Description
                                            element jQuery The element(s) to receive the oj-hover class on hover Required if afterToggle is specified.
                                            afterToggle function(string) <nullable>
                                            Optional callback function called each time the hover classes have been toggled, after the toggle. The string "mouseenter" or "mouseleave" is passed, indicating whether the classes were added or removed. Components with consistency requirements, such as "oj-default must be applied iff no state classes such as oj-hover are applied," can enforce those rules in this callback.
                                            Inherited From:
                                            Source:
                                            See:

                                            <protected> _AfterCreate()

                                            This method is called after _ComponentCreate, but before the create event is fired. The JET base component does tasks here that must happen after the component (subclass) has created itself in its override of _ComponentCreate. Notably, the base component handles the rootAttributes and contextMenu options here, since those options operate on the component root node, which for some components is created in their override of _ComponentCreate.

                                            Subclasses should override this method only if they have tasks that must happen after a superclass's implementation of this method, e.g. tasks that must happen after the context menu is set on the component.

                                            Overrides of this method should call this._super first.

                                            Inherited From:
                                            Source:

                                            <protected> _AfterCreateEvent()

                                            This method is called after the create event is fired. Components usually should not override this method, as it is rarely correct to wait until after the create event to perform a create-time task.

                                            An example of a correct usage of this method is Dialog's auto-open behavior, which needs to happen after the create event.

                                            Only behaviors (like Dialog auto-open behavior) should occur in this method. Component initialization must occur earlier, before the create event is fired, so that create listeners see a fully inited component.

                                            Overrides of this method should call this._super first.

                                            Do not confuse this method with the _AfterCreate method, which is more commonly used.

                                            Inherited From:
                                            Source:

                                            <protected> _CompareOptionValues(option, value1, value2) → {boolean}

                                            Compares 2 option values for equality and returns true if they are equal; false otherwise.

                                            Parameters:
                                            Name Type Description
                                            option String the name of the option
                                            value1 Object first value
                                            value2 Object another value
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            boolean

                                            <protected> _ComponentCreate()

                                            All component create-time initialization lives in this method, except the logic that specifically needs to live in _InitOptions, _AfterCreate, or _AfterCreateEvent, per the documentation for those methods. All DOM creation must happen here, since the intent of _AfterCreate, which is called next, is to contain superclass logic that must run after that DOM is created.

                                            Overrides of this method should call this._super first.

                                            Summary of create-time methods that components can override, in the order that they are called:

                                            1. _InitOptions
                                            2. _ComponentCreate (this method)
                                            3. _AfterCreate
                                            4. (The create event is fired here.)
                                            5. _AfterCreateEvent

                                            For all of these methods, the contract is that overrides must call this._super first, so e.g., the _ComponentCreate entry means baseComponent._ComponentCreate, then _ComponentCreate in any intermediate subclasses, then _ComponentCreate in the leaf subclass.

                                            Inherited From:
                                            Source:

                                            <protected> _ConvertLocatorToSubId()

                                            Source:

                                            <protected> _ConvertSubIdToLocator()

                                            Source:

                                            <protected> _create()

                                            This method is final in JET. Components should instead override one or more of the overridable create-time methods listed in _ComponentCreate.

                                            Inherited From:
                                            Source:

                                            <protected> _CreateDvtComponent(context, callback, callbackObj)

                                            Called by _create to instantiate the specific DVT component instance. Subclasses must override.
                                            Parameters:
                                            Name Type Description
                                            context dvt.Context
                                            callback Function
                                            callbackObj Object
                                            Inherited From:
                                            Source:

                                            <protected> _FixRendererContext(context) → {Object}

                                            Prepares a custom renderer context object for either the JQuery or custom element syntax, removing and exposing keys as needed.
                                            Parameters:
                                            Name Type Description
                                            context Object The renderer context object.
                                            Inherited From:
                                            Source:
                                            Returns:
                                            The cleaned up renderer context.
                                            Type
                                            Object

                                            <protected> _focusable(options)

                                            Sets JET's "focus" CSS classes when the element is focused and removes them when focus is lost.

                                            The oj-focus class is set on all focuses.

                                            Some components additionally have an oj-focus-highlight class, which applies a focus indicator that is appropriate on a subset of the occasions that oj-focus is appropriate. Those components should pass true for the applyHighlight param, in which case the oj-focus-highlight class is set if appropriate given the current focus highlight policy.

                                            Focus highlight policy

                                            The focus highlight policy supports the 3 values listed below. By default, it is retrieved from the $focusHighlightPolicy SASS variable, shared by many components and patterns. Components with different needs, including those exposing a component-specific SASS variable or other API for this, should see the getFocusHighlightPolicy parameter below. Valid focus highlight policies:

                                            Policy Description
                                            "nonPointer" Indicates that the component should apply the oj-focus-highlight class only for focuses not resulting from pointer (touch or mouse) interaction. (In the built-in themes, the SASS variable defaults to this value.)
                                            "all" Indicates that the component should apply the class for all focuses.
                                            "none" Indicates that the component should never apply the class, because the application has taken responsibility for applying the class when needed for accessibility.
                                            Toggling the classes

                                            Components that toggle these focus classes outside of this API must maintain the invariant that oj-focus-highlight is applied to a given element in a (not necessarily strict) subset of cases that oj-focus is applied to that element.

                                            Typically the specified element should be within the component subtree, in which case the classes will automatically be removed from the element when the component is destroyed, when its disabled option is set to true, and when _NotifyDetached() is called.

                                            As a minor exception, for components that wrap themselves in a new root node at create time, if the specified element is within the root node's subtree but not within the init node's subtree, then at destroy time only, the classes will not be removed, since destroy() is expected to remove such nodes.

                                            If the element is NOT in the component subtree, then the caller is responsible for removing the classes at the times listed above.

                                            Listeners

                                            If setupHandlers is not passed, or if setupHandlers is passed and uses _on to register its listeners as seen in the example, then the listeners are not invoked when the component is disabled, and the listeners are automatically cleaned up when the component is destroyed. Otherwise, the caller is responsible for ensuring that the disabled state is handled correctly, and removing the listeners at destroy time.

                                            Related API's

                                            Non-component internal callers should see oj.DomUtils.makeFocusable(). Per its JSDoc (unpublished; see the source), it has a couple of additional usage considerations.

                                            Parameters:
                                            Name Type Description
                                            options !Object | !jQuery This param can either be the element (convenience syntax for callers needing to specify only the element(s) that would otherwise have been passed as options.element) or an object supporting the following fields:
                                            Properties
                                            Name Type Argument Description
                                            element jQuery The element(s) to receive the oj-focus classes on focus. Required if setupHandlers not passed; ignored otherwise.
                                            applyHighlight boolean true if the oj-focus-highlight class should be applied when appropriate. false or omitted if that class should never be applied.
                                            afterToggle function(string) <nullable>
                                            Optional callback function called each time the focus classes have been toggled, after the toggle. The string "focusin" or "focusout" is passed, indicating whether the classes were added or removed. Components with consistency requirements, such as "oj-default must be applied iff no state classes such as oj-focus are applied," can enforce those rules in this callback.
                                            getFocusHighlightPolicy function() <nullable>
                                            Optional if applyHighlight is true; ignored otherwise. Components with a component-specific focus policy mechanism should pass a function that always returns one of the three valid values listed above, keeping in mind that this method can be called on every focus. See the example.
                                            recentPointer function() <nullable>
                                            Relevant iff applyHighlight is true and the focus highlight policy is "nonPointer"; ignored otherwise. Recent pointer activity is considered to have occurred if (a) a mouse button or finger has recently been down or up, or (b) this optional callback function returns true. Components wishing to additionally take into account (say) recent pointer movements can supply a function returning true if those movements have been detected, keeping in mind that this method can be called on every focus. See the example.
                                            setupHandlers function(function(!jQuery),function(!jQuery)) <nullable>
                                            Can be omitted by components whose focus classes need to be added and removed on focusin and focusout, respectively. Components needing to add/remove those classes in response to other events should specify this parameter, which is called once, immediately. See the examples.
                                            Inherited From:
                                            Source:
                                            Examples

                                            Opt into the highlight behavior, and specify a function to be called every time the classes are toggled:

                                            var self = this;
                                            this._focusable({
                                                'element': this.element, 
                                                'applyHighlight': true, 
                                                'afterToggle' : function() {
                                                    self._toggleDefaultClasses();
                                                }
                                            });

                                            Arrange for mouse movement to be considered in addition to mouse/finger up/down. Also supply a component-specific focusHighlightPolicy:

                                            var self = this;
                                            this._focusable({
                                                'element': someElement, 
                                                'applyHighlight': true, 
                                                'recentPointer' : function() {
                                                    // A timestamp-based approach avoids the risk of getting stuck in an inaccessible 
                                                    // state if (say) mouseenter is not followed by mouseleave for some reason.
                                                    var millisSincePointerMove = Date.now() - _myPointerMoveTimestamp;
                                                    var isRecent = millisSincePointerMove < myThreshold;
                                                    return isRecent;
                                                },
                                                'getFocusHighlightPolicy' : function() {
                                                    // Return the value of a component-specific SASS $variable, component option, or other 
                                                    // component-specific mechanism, either "all", "none", or "nonPointer".  SASS variables
                                                    // should be pulled into JS once statically on load, not per-instance or per-focus.
                                                }
                                            });

                                            Add/remove the focus classes in response to events other than focusin/focusout:

                                            var self = this;
                                            this._focusable({
                                                'applyHighlight': myBooleanValue, 
                                                'setupHandlers': function( focusInHandler, focusOutHandler) {
                                                    self._on( self.element, {
                                                        // This example uses focus/blur listeners, which don't bubble, rather than the 
                                                        // default focusin/focusout (which bubble).  This is useful when one focusable  
                                                        // element is a descendant of another.
                                                        focus: function( event ) {
                                                            focusInHandler($( event.currentTarget ));
                                                        },
                                                        blur: function( event ) {
                                                            focusOutHandler($( event.currentTarget ));
                                                        }
                                                    });
                                                }
                                            });

                                            Alternate usage of setupHandlers, which simply stashes the handlers so they can be called from the component's existing handlers:

                                            var self = this;
                                            this._focusable({
                                                'applyHighlight': myBooleanValue, 
                                                'setupHandlers': function( focusInHandler, focusOutHandler) {
                                                    self._focusInHandler = focusInHandler;
                                                    self._focusOutHandler = focusOutHandler;
                                                }
                                            });

                                            <protected> _GetChildStyleClasses() → {Object}

                                            Returns a map of the style classes associated with a component's children.
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            Object

                                            <protected> _GetComponentDeferredDataPaths() → {Object}

                                            Returns an object containing the top level options key and subkeys for deferred data options. 'root' is used for top level keys. For example, {'areaLayers': ['areaDataLayer/areas', 'areaDataLayer/markers'] indicates that we should check this.options['areaLayers'][i]['areaDataLayer']['areas'] and this.options['areaLayers'][i]['areaDataLayer']['markers']. To indicate a top level option, use the options key 'root', i.e. {'root': ['items']}.
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            Object

                                            <protected> _GetComponentNoClonePaths() → {Object}

                                            Returns an object containing the no clone paths for a component. For example, {'areaLayers': {'areaDataLayer': {'areas': true, 'markers': true}}} indicates that we should check this.options['areaLayers'][i]['areaDataLayer']['areas'] and this.options['areaLayers'][i]['areaDataLayer']['markers']. The base implementation will handle the basic case where the deferred data path contains only top level data options.
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            Object

                                            <protected> _GetComponentStyleClasses() → {Array}

                                            Returns the style classes associated with the component.
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            Array

                                            <protected> _getCreateOptions()

                                            This method is not used in JET. Components should instead override _InitOptions.

                                            Inherited From:
                                            Source:

                                            <protected> _GetDataContext(options) → {Object}

                                            Returns the data context passed to data function callbacks.
                                            Parameters:
                                            Name Type Description
                                            options Object The options to retrieve the data context for
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            Object

                                            <protected> _GetDvtComponent(element) → {Object}

                                            Returns a DVT component associated with a DOMElement
                                            Parameters:
                                            Name Type Description
                                            element Element The DOMElement to get the DVT component from.
                                            Inherited From:
                                            Source:
                                            Returns:
                                            The DVT component associated with the DOMElement or null
                                            Type
                                            Object

                                            <protected> _GetEventForSyntax(event) → {Object}

                                            Given an event, returns the appropriate event for the component syntax. For custom elements, if the event is a JQuery event, this method will return the unwrapped original event.
                                            Parameters:
                                            Name Type Description
                                            event Object [description]
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            Object

                                            <protected> _GetEventTypes() → {Array}

                                            Returns an array of supported event types. Used in conjunction with _setOptions to skip unnecessary rendering when event listeners are bound. Subclasses must override to return supported event types.
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            Array

                                            <protected> _GetFirstBracketedString(subId) → {string}

                                            Returns the first bracketed substring in the specified string.
                                            Parameters:
                                            Name Type Description
                                            subId string
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            string

                                            <protected> _GetFirstIndex(subId) → {number}

                                            Converts a string containing a single index in the form '[index]' into the numerical index.
                                            Parameters:
                                            Name Type Description
                                            subId string
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            number

                                            <protected> _GetIndexPath(subId) → {Array}

                                            Converts a string containing indices in the form '[index0][index1]...[indexN]' to an array of indices.
                                            Parameters:
                                            Name Type Description
                                            subId string
                                            Inherited From:
                                            Source:
                                            Returns:
                                            The resulting array to be used for locator indexPath.
                                            Type
                                            Array

                                            <protected> _GetReadingDirection() → {string}

                                            Determines whether the component is LTR or RTL.

                                            Component responsibilities:

                                            • All components must determine directionality exclusively by calling this protected superclass method. (So that any future updates to the logic can be made in this one place.)
                                            • Components that need to know the directionality must call this method at create-time and from refresh(), and cache the value.
                                            • Components should not call this at other times, and should instead use the cached value. (This avoids constant DOM queries, and avoids any future issues with component reparenting (i.e. popups) if support for directional islands is added.)

                                            App responsibilities:

                                            • The app specifies directionality by setting the HTML "dir" attribute on the <html> node. When omitted, the default is "ltr". (Per-component directionality / directional islands are not currently supported due to inadequate CSS support.)
                                            • As with any DOM change, the app must refresh() the component if the directionality changes dynamically. (This provides a hook for component housekeeping, and allows caching.)
                                            Default Value:
                                            • "ltr"
                                            Inherited From:
                                            Source:
                                            Returns:
                                            the reading direction, either "ltr" or "rtl"
                                            Type
                                            string

                                            <protected> _GetSavedAttributes(element) → {Object|null}

                                            Gets the saved attributes for the provided element.

                                            If you don't override _SaveAttributes and _RestoreAttributes, then this will return null.

                                            If you override _SaveAttributes to call _SaveAllAttributes, then this will return all the attributes. If you override _SaveAttributes/_RestoreAttributes to do your own thing, then you may also have to override _GetSavedAttributes to return whatever you saved if you need access to the saved attributes.

                                            Parameters:
                                            Name Type Description
                                            element Object jQuery selection, should be a single entry
                                            Inherited From:
                                            Source:
                                            Returns:
                                            savedAttributes - attributes that were saved for this element in _SaveAttributes, or null if none were saved.
                                            Type
                                            Object | null

                                            <protected> _GetStringFromIndexPath(indexPath) → {string}

                                            Converts an indexPath array to a string of the form '[index0][index1]...[indexN]'.
                                            Parameters:
                                            Name Type Description
                                            indexPath Array
                                            Inherited From:
                                            Source:
                                            Returns:
                                            The resulting string.
                                            Type
                                            string

                                            <protected> _GetTranslationMap() → {Object}

                                            Returns a map containing keys corresponding to the string ids in ojtranslations.js and values corresponding to the toolkit constants for the DvtBundle objects. This map must be guaranteed to be a new instance so that subclasses can add their translations to it.
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            Object

                                            <protected> _HandleEvent(event)

                                            Called by the component to process events. Subclasses should override to delegate DVT component events to their JQuery listeners.
                                            Parameters:
                                            Name Type Description
                                            event Object
                                            Inherited From:
                                            Source:

                                            <protected> _init()

                                            JET components should almost never implement this JQUI method. Please consult an architect if you believe you have an exception. Reasons:

                                            • This method is called at create time, after the create event is fired. It is rare for that to be the appropriate time to perform a create-time task. For those rare cases, we have the _AfterCreateEvent method, which is preferred over this method since it is called only at that time, not also at re-init time (see next).
                                            • This method is also called at "re-init" time, i.e. when the initializer is called after the component has already been created. JET has not yet identified any desired semantics for re-initing a component.
                                            Inherited From:
                                            Source:

                                            <protected> _InitOptions(originalDefaults, constructorOptions)

                                            This method is called before _ComponentCreate, at which point the component has not yet been rendered. Component options should be initialized in this method, so that their final values are in place when _ComponentCreate is called.

                                            This includes getting option values from the DOM, where applicable, and coercing option values (however derived) to their appropriate data type if needed.

                                            No work other than setting options should be done in this method. In particular, nothing should be set on the DOM until _ComponentCreate, e.g. setting the disabled DOM attribute from the disabled option.

                                            A given option (like disabled) appears in the constructorOptions param iff the app set it in the constructor:

                                            • If it appears in constructorOptions, it should win over what's in the DOM (e.g. disabled DOM attribute). If for some reason you need to tweak the value that the app set, then enable writeback when doing so: this.option('foo', bar, {'_context': {writeback: true, internalSet: true}}).
                                            • If it doesn't appear in constructorOptions, then that option definitely is not bound, so writeback is not needed. So if you need to set the option (e.g. from a DOM attribute), use this.option('foo', bar, {'_context': {internalSet: true}}).

                                            Overrides of this method should call this._super first.

                                            Parameters:
                                            Name Type Argument Description
                                            originalDefaults Object original default options defined on the component and its ancestors
                                            constructorOptions Object <nullable>
                                            options passed into the widget constructor
                                            Inherited From:
                                            Source:

                                            <protected> _IsCustomElement() → {boolean}

                                            Determines whether the component is being rendered as a custom element.
                                            Inherited From:
                                            Source:
                                            Returns:
                                            True if the component is being rendered as a custom element
                                            Type
                                            boolean

                                            <protected> _IsEffectivelyDisabled() → {boolean}

                                            Determines whether this component is effectively disabled, i.e. it has its 'disabled' attribute set to true or it has been disabled by its ancestor component.

                                            Inherited From:
                                            Source:
                                            Returns:
                                            true if the component has been effectively disabled, false otherwise
                                            Type
                                            boolean

                                            <protected> _IsFlowingLayoutSupported() → {boolean}

                                            Returns whether flowing layout is supported for the component. If this returns true, the component will render at the preferred size of the component if the user doesn't specify the width and height in the div. If this returns false, the component will always render at the browser- computed width and height.
                                            Inherited From:
                                            Source:
                                            Returns:
                                            Type
                                            boolean

                                            <protected> _LoadResources()

                                            Called once during component creation to load resources.
                                            Inherited From:
                                            Source:

                                            <protected> _MakeReady()

                                            Called by component to declare rendering is finished. This method currently handles the ready state for the component whenReady API, the page level BusyContext, and the static whenReady API for the custom element version of this component.
                                            Inherited From:
                                            Source:

                                            <protected> _NotifyAttached()

                                            Notifies the component that its subtree has been connected to the document programmatically after the component has been created.

                                            Inherited From:
                                            Source:

                                            <protected> _NotifyContextMenuGesture(menu, event, eventType)

                                            When the contextMenu option is set, this method is called when the user invokes the context menu via the default gestures: right-click, Press & Hold, and Shift-F10. Components should not call this method directly.

                                            The default implementation simply calls this._OpenContextMenu(event, eventType). Overrides of this method should call that same method, perhaps with additional params, not menu.open().

                                            This method may be overridden by components needing to do things like the following:

                                            • Customize the launcher or position passed to _OpenContextMenu(). See that method for guidance on these customizations.
                                            • Customize the menu contents. E.g. some components need to enable/disable built-in commands like Cut and Paste, based on state at launch time.
                                            • Bail out in some cases. E.g. components with UX approval to use PressHoldRelease rather than Press & Hold can override this method to say if (eventType !== "touch") this._OpenContextMenu(event, eventType);. When those components detect the alternate context menu gesture (e.g. PressHoldRelease), that separate listener should call this._OpenContextMenu(), not this method (_NotifyContextMenuGesture()), and not menu.open().

                                            Components needing to do per-launch setup like the above tasks should do so in an override of this method, not in a beforeOpen listener or an _OpenContextMenu() override. This is discussed more fully here.

                                            Parameters:
                                            Name Type Description
                                            menu Object The JET Menu to open as a context menu. Always non-null.
                                            event Event What triggered the menu launch. Always non-null.
                                            eventType string "mouse", "touch", or "keyboard". Never null.
                                            Inherited From:
                                            Source:

                                            <protected> _NotifyDetached()

                                            Notifies the component that its subtree has been removed from the document programmatically after the component has been created.

                                            Inherited From:
                                            Source:

                                            <protected> _NotifyDetached()

                                            Notifies the component that its subtree has been removed from the document programmatically after the component has been created.

                                            Inherited From:
                                            Source:

                                            <protected> _NotifyHidden()

                                            Notifies the component that its subtree has been made hidden programmatically after the component has been created.

                                            Inherited From:
                                            Source:

                                            <protected> _NotifyShown()

                                            Notifies the component that its subtree has been made visible programmatically after the component has been created.

                                            Inherited From:
                                            Source:

                                            <protected> _NotReady()

                                            Called by component to declare rendering is not finished. This method currently handles the ready state for the component whenReady API, the page level BusyContext, and the static whenReady API for the custom element version of this component.
                                            Inherited From:
                                            Source:

                                            <protected> _OpenContextMenu(event, eventType, openOptions, submenuOpenOptions, shallow)

                                            The only correct way for a component to open its context menu is by calling this method, not by calling Menu.open() or _NotifyContextMenuGesture(). This method should be called in two cases:

                                            • This method is called by _NotifyContextMenuGesture() and its overrides. That method is called when the baseComponent detects the default context menu gestures: right-click, Press & Hold, and Shift-F10.
                                            • Components with UX-approved support for alternate context menu gestures like PressHoldRelease should call this method directly when those gestures are detected.

                                            Components needing to customize how the context menu is launched, or do any per-launch setup, should do so in the caller of this method, (which is one of the two callers listed above), often by customizing the params passed to this method (_OpenContextMenu) per the guidance below. This setup should not be done in the following ways:

                                            • Components should not perform setup in a beforeOpen listener, as this can cause a race condition where behavior depends on who got their listener registered first: the component or the app. The only correct component use of a beforeOpen listener is when there's a need to detect whether something else launched the menu.
                                            • Components should not override this method (_OpenContextMenu), as this method is final. Instead, customize the params that are passed to it.

                                            Guidance on setting OpenOptions fields:

                                            Launcher:

                                            Depending on individual component needs, any focusable element within the component can be the appropriate launcher for this launch.

                                            Browser focus returns to the launcher on menu dismissal, so the launcher must at least be focusable. Typically a tabbable (not just focusable) element is safer, since it just focuses something the user could have focused on their own.

                                            By default (i.e. if openOptions is not passed, or if it lacks a launcher field), the component init node is used as the launcher for this launch. If that is not focusable or is suboptimal for a given component, that component should pass something else. E.g. components with a "roving tabstop" (like Toolbar) should typically choose the current tabstop as their launcher.

                                            The :focusable and :tabbable selectors may come in handy for choosing a launcher, e.g. something like this.widget().find(".my-class:tabbable").first().

                                            Position:

                                            By default, this method applies positioning that differs from Menu's default in the following ways: (The specific settings are subject to change.)

                                            • For mouse and touch events, the menu is positioned relative to the event, not the launcher.
                                            • For touch events, "my" is set to "start>40 center", to avoid having the context menu obscured by the user's finger.

                                            Usually, if position needs to be customized at all, the only thing that needs changing is its "of" field, and only for keyboard launches (since mouse/touch launches should almost certainly keep the default "event" positioning). This situation arises anytime the element relative to which the menu should be positioned for keyboard launches is different than the launcher element (the element to which focus should be returned upon dismissal). For this case, { "position": {"of": eventType==="keyboard" ? someElement : "event"} } can be passed as the openOptions param.

                                            Be careful not to clobber useful defaults by specifying too much. E.g. if you only want to customize "of", don't pass other fields like "my", since your value will be used for all modalities (mouse, touch, keyboard), replacing the modality-specific defaults that are usually correct. Likewise, don't forget the eventType==="keyboard" check if you only want to customize "of" for keyboard launches.

                                            InitialFocus:

                                            This method forces initialFocus to "menu" for this launch, so the caller needn't specify it.

                                            Parameters:
                                            Name Type Argument Description
                                            event Event What triggered the context menu launch. Must be non-null.
                                            eventType string "mouse", "touch", or "keyboard". Must be non-null. Passed explicitly since caller knows what it's listening for, and since events like contextmenu and click can be generated by various input modalities, making it potentially error-prone for this method to determine how they were generated.
                                            openOptions Object <optional>
                                            Options to merge with this method's defaults, which are discussed above. The result will be passed to Menu.open(). May be null or omitted. See also the shallow param.
                                            submenuOpenOptions Object <optional>
                                            Options to be passed through to Menu.open(). May be null or omitted.
                                            shallow boolean <optional>
                                            Whether to perform a deep or shallow merge of openOptions with this method's default value. The default and most commonly correct / useful value is false.
                                            • If true, a shallow merge is performed, meaning that the caller's position object, if passed, will completely replace this method's default position object.
                                            • If false or omitted, a deep merge is performed. For example, if the caller wishes to tweak position.of while keeping this method's defaults for position.my, position.at, etc., it can pass {"of": anOfValue} as the position value.

                                            The shallow param is n/a for submenuOpenOptions, since this method doesn't apply any defaults to that. (It's a direct pass-through.)

                                            Inherited From:
                                            Source:

                                            <protected> _ProcessStyles()

                                            Create dummy divs for style classes and merge style class values with json . options object
                                            Inherited From:
                                            Source:

                                            <protected> _ReleaseResources()

                                            Release resources held by this component, for example, remove listeners. This is called during destroy. _SetupResources will set up resources needed by this component, and is called during _create.

                                            This base class default implementation does nothing.

                                            Component subclasses can opt in by overriding _SetupResources and _ReleaseResources.
                                            Inherited From:
                                            Source:

                                            <protected> _RemoveActiveable(element)

                                            Remove touch and mouse listeners that were registered in _AddActiveable
                                            Parameters:
                                            Name Type Description
                                            element jQuery The same element passed to _AddActiveable
                                            Inherited From:
                                            Source:
                                            See:

                                            <protected> _RemoveHoverable(element)

                                            Remove mouse listners that were registered in _AddHoverable
                                            Parameters:
                                            Name Type Description
                                            element jQuery The same element passed to _AddHoverable
                                            Inherited From:
                                            Source:
                                            See:

                                            <protected> _Render(isResize)

                                            Called to render the component at the current size.
                                            Parameters:
                                            Name Type Description
                                            isResize boolean (optional) Whether it is a resize rerender.
                                            Inherited From:
                                            Source:

                                            <protected> _RestoreAllAttributes()

                                            Restores all the element's attributes which were saved in _SaveAllAttributes. This method is final in JET.

                                            If a subclass wants to save/restore all attributes on create/destroy, then the subclass can override _SaveAttributes and call _SaveAllAttributes and also override _RestoreAttributes and call _RestoreAllAttributes.

                                            Inherited From:
                                            Source:

                                            <protected> _RestoreAttributes()

                                            Restore the attributes saved in _SaveAttributes.

                                            _SaveAttributes is called during _create. And _RestoreAttributes is called during _destroy.

                                            This base class default implementation does nothing.

                                            We also have _SaveAllAttributes and _RestoreAllAttributes methods that save and restore all the attributes on an element. Component subclasses can opt into these _SaveAllAttributes/_RestoreAllAttributes implementations by overriding _SaveAttributes and _RestoreAttributes to call _SaveAllAttributes/_RestoreAllAttributes. If the subclass wants a different implementation (like save only the 'class' attribute), it can provide the implementation itself in _SaveAttributes/_GetSavedAttributes/_RestoreAttributes.

                                            Inherited From:
                                            Source:

                                            <protected> _SaveAllAttributes(element)

                                            Saves all the element's attributes within an internal variable. _RestoreAllAttributes will restore the attributes from this internal variable.

                                            This method is final in JET. Subclasses can override _RestoreAttributes and call _RestoreAllAttributes.

                                            The JSON variable will be held as:

                                            [
                                              {
                                              "element" : element[i],
                                              "attributes" :
                                                {
                                                  attributes[m]["name"] : {"attr": attributes[m]["value"]
                                                }
                                              }
                                            ]
                                            
                                            Parameters:
                                            Name Type Description
                                            element Object jQuery selection to save attributes for
                                            Inherited From:
                                            Source:

                                            <protected> _SaveAttributes(element)

                                            Saves the element's attributes. This is called during _create. _RestoreAttributes will restore all these attributes and is called during _destroy.

                                            This base class default implementation does nothing.

                                            We also have _SaveAllAttributes and _RestoreAllAttributes methods that save and restore all the attributes on an element. Component subclasses can opt into these _SaveAllAttributes/_RestoreAllAttributes implementations by overriding _SaveAttributes and _RestoreAttributes to call _SaveAllAttributes/_RestoreAllAttributes. If the subclass wants a different implementation (like save only the 'class' attribute), it can provide the implementation itself in _SaveAttributes/_RestoreAttributes.

                                            Parameters:
                                            Name Type Description
                                            element Object jQuery selection to save attributes for
                                            Inherited From:
                                            Source:

                                            <protected> _SetRootAttributes()

                                            Reads the rootAttributes option, and sets the root attributes on the component's root DOM element. See rootAttributes for the set of supported attributes and how they are handled.

                                            Inherited From:
                                            Source:
                                            Throws:
                                            if unsupported attributes are supplied.

                                            <protected> _SetupResources()

                                            Sets up needed resources for this component, for example, add listeners. This is called during _create. _ReleaseResources will release resources help by this component, and is called during destroy.

                                            This base class default implementation does nothing.

                                            Component subclasses can opt in by overriding _SetupResources and _ReleaseResources.
                                            Inherited From:
                                            Source:

                                            <protected> _UnregisterChildNode()

                                            Remove all listener references that were attached to the element.
                                            Inherited From:
                                            Source:

                                            <protected> _UserOptionChange(key, value, optionMetadata)

                                            Sets an option change that was driven by user gesture. Used in conjunction with _setOption to ensure that the correct optionMetadata flag for writeback is set.
                                            Parameters:
                                            Name Type Description
                                            key string The name of the option to set.
                                            value Object The value to set for the option.
                                            optionMetadata Object The optionMetadata for the optionChange event
                                            Inherited From:
                                            Source: