Source: 3rdparty/dvt/doc/ojtimeline_options.js

Oracle® JavaScript Extension Toolkit (JET)
1.1.2

E65298-01

/**
 * The end time of the timeline. This is required in order for the timeline to properly render.
 * @expose
 * @name end
 * @memberof oj.ojTimeline
 * @instance
 * @type {string|number|Date}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object with the following properties, used to define a timeline axis. This is required in order for the timeline to properly render.
 * @expose
 * @name minorAxis
 * @memberof oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The 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.
 * @expose
 * @name minorAxis.converter
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The default converter to use for all 'scale' values that do not otherwise have a converter object provided.
 * @expose
 * @name minorAxis.converter.default
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'seconds' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name minorAxis.converter.seconds
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'minutes' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name minorAxis.converter.minutes
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'hours' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name minorAxis.converter.hours
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'days' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name minorAxis.converter.days
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'weeks' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name minorAxis.converter.weeks
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'months' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name minorAxis.converter.months
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'quarters' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name minorAxis.converter.quarters
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'years' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name minorAxis.converter.years
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The time scale used for the minorAxis. This is required in order for the timeline to properly render.
 * @expose
 * @name minorAxis.scale
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @ojvalue {string} "seconds"
 * @ojvalue {string} "minutes"
 * @ojvalue {string} "hours"
 * @ojvalue {string} "days"
 * @ojvalue {string} "weeks"
 * @ojvalue {string} "months"
 * @ojvalue {string} "quarters"
 * @ojvalue {string} "years"
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining any additional styling of the axis. If not specified, no additional styling will be applied.
 * @expose
 * @name minorAxis.style
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * 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.
 * @expose
 * @name minorAxis.zoomOrder
 * @memberof! oj.ojTimeline
 * @instance
 * @type {Array.<string>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * 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.
 * @expose
 * @name majorAxis
 * @memberof oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The 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.
 * @expose
 * @name majorAxis.converter
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The default converter to use for all 'scale' values that do not otherwise have a converter object provided.
 * @expose
 * @name majorAxis.converter.default
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'seconds' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name majorAxis.converter.seconds
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'minutes' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name majorAxis.converter.minutes
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'hours' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name majorAxis.converter.hours
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'days' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name majorAxis.converter.days
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'weeks' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name majorAxis.converter.weeks
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'months' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name majorAxis.converter.months
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'quarters' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name majorAxis.converter.quarters
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The converter used for the 'years' scale. If not specified, the default converter will be used for this scale.
 * @expose
 * @name majorAxis.converter.years
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The time scale used for the majorAxis. If not specified, no axis labels will be shown above the minorAxis or in the overview.
 * @expose
 * @name majorAxis.scale
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @ojvalue {string} "seconds"
 * @ojvalue {string} "minutes"
 * @ojvalue {string} "hours"
 * @ojvalue {string} "days"
 * @ojvalue {string} "weeks"
 * @ojvalue {string} "months"
 * @ojvalue {string} "quarters"
 * @ojvalue {string} "years"
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining any additional styling of the axis. If not specified, no additional styling will be applied.
 * @expose
 * @name majorAxis.style
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The orientation of the component.
 * @expose
 * @name orientation
 * @memberof oj.ojTimeline
 * @instance
 * @type {string}
 * @ojvalue {string} "vertical"
 * @ojvalue {string} "horizontal"
 * @default <code class="prettyprint">"horizontal"</code>
 */
/**
 * An object with the following properties, used to define a timeline overview. If not specified, no overview will be shown.
 * @expose
 * @name overview
 * @memberof oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * Specifies whether the overview scrollbar is rendered.
 * @expose
 * @name overview.rendered
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @ojvalue {string} "on"
 * @ojvalue {string} "off"
 * @default <code class="prettyprint">"off"</code>
 */
/**
 * The CSS style string defining any additional styling of the overview. If not specified, no additional styling will be applied.
 * @expose
 * @name overview.style
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * 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.
 * @expose
 * @name referenceObjects
 * @memberof oj.ojTimeline
 * @instance
 * @type {Array.<Object>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The value of this reference object. If not specified, no reference object will be shown.
 * @expose
 * @name referenceObjects[].value
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string|number|Date}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An array of strings containing the ids of the initially selected items.
 * @expose
 * @name selection
 * @memberof oj.ojTimeline
 * @instance
 * @type {Array.<string>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * 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.
 * @expose
 * @name selectionMode
 * @memberof oj.ojTimeline
 * @instance
 * @type {string}
 * @ojvalue {string} "single"
 * @ojvalue {string} "multiple"
 * @ojvalue {string} "none"
 * @default <code class="prettyprint">"none"</code>
 */
/**
 * An array of objects with the following properties, used to define a timeline series.
 * @expose
 * @name series
 * @memberof oj.ojTimeline
 * @instance
 * @type {Array.<Object>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The text of an empty timeline series.
 * @expose
 * @name series[].emptyText
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The identifier for the timeline series.
 * @expose
 * @name series[].id
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * 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.
 * @expose
 * @name series[].items
 * @memberof! oj.ojTimeline
 * @instance
 * @type {Array.<Object>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The description text displayed on the timeline item. If not specified, no description will be shown.
 * @expose
 * @name series[].items[].description
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The end time of this timeline item. If not specified, no duration bar will be shown.
 * @expose
 * @name series[].items[].end
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string|number|Date}
 * @default <code class="prettyprint">null</code>
 */
/**
 * 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.
 * @expose
 * @name series[].items[].durationFillColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * 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.
 * @expose
 * @name series[].items[].id
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The start time of this timeline item. This is required in order for the timeline item to properly render.
 * @expose
 * @name series[].items[].start
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string|number|Date}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining any additional styling of the item. If not specified, no additional styling will be applied.
 * @expose
 * @name series[].items[].style
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * 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.
 * @expose
 * @name series[].items[].thumbnail
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The title text displayed on the timeline item. If not specified, no title will be shown.
 * @expose
 * @name series[].items[].title
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The label displayed on the timeline series. In not specified, no label will be shown.
 * @expose
 * @name series[].label
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining any additional styling of the series. If not specified, no additional styling will be applied.
 * @expose
 * @name series[].style
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The start time of the timeline. This is required in order for the timeline to properly render.
 * @expose
 * @name start
 * @memberof oj.ojTimeline
 * @instance
 * @type {string|number|Date}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object with the following properties, used to define default styling for the timeline.
 * @expose
 * @name styleDefaults
 * @memberof oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color of the timeline.
 * @expose
 * @name styleDefaults.borderColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object with the following properties, used to define the default styling for the timeline item.
 * @expose
 * @name styleDefaults.item
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The background color of the timeline items.
 * @expose
 * @name styleDefaults.item.backgroundColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color of the timeline items.
 * @expose
 * @name styleDefaults.item.borderColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining the style of the timeline item description text.
 * @expose
 * @name styleDefaults.item.descriptionStyle
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The background color of the highlighted timeline items.
 * @expose
 * @name styleDefaults.item.hoverBackgroundColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color of the highlighted timeline items.
 * @expose
 * @name styleDefaults.item.hoverBorderColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The background color of the selected timeline items.
 * @expose
 * @name styleDefaults.item.selectedBackgroundColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color of the selected timeline items.
 * @expose
 * @name styleDefaults.item.selectedBorderColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining the style of the timeline item title text.
 * @expose
 * @name styleDefaults.item.titleStyle
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object with the following properties, used to define the default styling for the time axis.
 * @expose
 * @name styleDefaults.minorAxis
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The background color of the time axis.
 * @expose
 * @name styleDefaults.minorAxis.backgroundColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color of the time axis.
 * @expose
 * @name styleDefaults.minorAxis.borderColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining the style of the time axis label text.
 * @expose
 * @name styleDefaults.minorAxis.labelStyle
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The color of the time axis separators.
 * @expose
 * @name styleDefaults.minorAxis.separatorColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object with the following properties, used to define the default styling for the major time axis.
 * @expose
 * @name styleDefaults.majorAxis
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining the style of the major time axis label text.
 * @expose
 * @name styleDefaults.majorAxis.labelStyle
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The color of the major time axis separators.
 * @expose
 * @name styleDefaults.majorAxis.separatorColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object with the following properties, used to define the default styling for the timeline overview.
 * @expose
 * @name styleDefaults.overview
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The background color of the timeline overview.
 * @expose
 * @name styleDefaults.overview.backgroundColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining the style of the timeline overview label text.
 * @expose
 * @name styleDefaults.overview.labelStyle
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object with the following properties, used to define the default styling for the timeline overview window.
 * @expose
 * @name styleDefaults.overview.window
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The background color of the timeline overview window.
 * @expose
 * @name styleDefaults.overview.window.backgroundColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color of the timeline overview window.
 * @expose
 * @name styleDefaults.overview.window.borderColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object with the following properties, used to define the default styling for the reference objects.
 * @expose
 * @name styleDefaults.referenceObject
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The color of the reference objects.
 * @expose
 * @name styleDefaults.referenceObject.color
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object with the following properties, used to define the default styling for the timeline series.
 * @expose
 * @name styleDefaults.series
 * @memberof! oj.ojTimeline
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The background color of the series.
 * @expose
 * @name styleDefaults.series.backgroundColor
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The array defining the default color ramp for the series items.
 * @expose
 * @name styleDefaults.series.colors
 * @memberof! oj.ojTimeline
 * @instance
 * @type {Array.<string>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining the style of the series empty text.
 * @expose
 * @name styleDefaults.series.emptyTextStyle
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining the style of the series label text.
 * @expose
 * @name styleDefaults.series.labelStyle
 * @memberof! oj.ojTimeline
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * 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.
 * @expose
 * @name viewportEnd
 * @memberof oj.ojTimeline
 * @instance
 * @type {string|number|Date}
 * @default <code class="prettyprint">null</code>
 */
/**
 * 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.
 * @expose
 * @name viewportStart
 * @memberof oj.ojTimeline
 * @instance
 * @type {string|number|Date}
 * @default <code class="prettyprint">null</code>
 */