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

Oracle® JavaScript Extension Toolkit (JET)
1.1.2

E65298-01

/**
 * An array of objects with the following properties that defines the data for the spark chart.
 * @expose
 * @name items
 * @memberof oj.ojSparkChart
 * @instance
 * @type {Array.<Object>|Array.<number>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The value of the data item.
 * @expose
 * @name items[].value
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The low value for range bar/area. Define 'low' and 'high' instead of 'value' to create a range bar/area spark chart.
 * @expose
 * @name items[].low
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The high value for range bar/area. Define 'low' and 'high' instead of 'value' to create a range bar/area spark chart.
 * @expose
 * @name items[].high
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The float value for the data item. Only applies for floating bar spark charts.
 * @expose
 * @name items[].floatValue
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 * @deprecated Use low and high instead
 */
/**
 * The date for the data item. The date should only be specified if the interval between data items is irregular.
 * @expose
 * @name items[].date
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {Date}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The color of the bar or marker for the data item. This override can be used to highlight important values or thresholds.
 * @expose
 * @name items[].color
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * Defines whether a marker should be displayed for the data item. Only applies to line and area spark charts.
 * @expose
 * @name items[].markerDisplayed
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "on"
 * @ojvalue {string} "off"
 * @default <code class="prettyprint">"off"</code>
 */
/**
 * The default border color for the data items.
 * @expose
 * @name items[].borderColor
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The shape of the data markers. Only applies to line and area spark charts.
 * @expose
 * @name items[].markerShape
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "square"
 * @ojvalue {string} "circle"
 * @ojvalue {string} "diamond"
 * @ojvalue {string} "plus"
 * @ojvalue {string} "triangleDown"
 * @ojvalue {string} "triangleUp"
 * @ojvalue {string} "human"
 * @ojvalue {string} "auto"
 * @default <code class="prettyprint">"auto"</code>
 */
/**
 * The size of the data markers in pixels. Only applies to line and area spark charts.
 * @expose
 * @name items[].markerSize
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An array of objects with the following properties defining the reference objects associated with the y axis of the spark chart.
 * @expose
 * @name referenceObjects
 * @memberof oj.ojSparkChart
 * @instance
 * @type {Array.<Object>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The type of reference object being shown.
 * @expose
 * @name referenceObjects[].type
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "area"
 * @ojvalue {string} "line"
 * @default <code class="prettyprint">"line"</code>
 */
/**
 * The location of the reference object relative to the data items.
 * @expose
 * @name referenceObjects[].location
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "front"
 * @ojvalue {string} "back"
 * @default <code class="prettyprint">"back"</code>
 */
/**
 * The color of the reference object.
 * @expose
 * @name referenceObjects[].color
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The width of a reference line.
 * @expose
 * @name referenceObjects[].lineWidth
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The line style of a reference line.
 * @expose
 * @name referenceObjects[].lineStyle
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "dotted"
 * @ojvalue {string} "dashed"
 * @default <code class="prettyprint">null</code>
 */
/**
 * The value of a reference line.
 * @expose
 * @name referenceObjects[].value
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The low value of a reference area.
 * @expose
 * @name referenceObjects[].low
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The high value of a reference area.
 * @expose
 * @name referenceObjects[].high
 * @memberof! oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The chart type.
 * @expose
 * @name type
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "area"
 * @ojvalue {string} "lineWithArea"
 * @ojvalue {string} "bar"
 * @ojvalue {string} "line"
 * @default <code class="prettyprint">"line"</code>
 */
/**
 * The color of the data items.
 * @expose
 * @name color
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The color of the area in area or lineWithArea spark chart.
 * @expose
 * @name areaColor
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The color of the first data item.
 * @expose
 * @name firstColor
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The color of the last data item.
 * @expose
 * @name lastColor
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The color of the data item with the greatest value.
 * @expose
 * @name highColor
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The color of the data item with the lowest value.
 * @expose
 * @name lowColor
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The duration of the animations, in milliseconds. Also accepts CSS strings such as 1s and 1000ms.
 * @expose
 * @name animationDuration
 * @memberof oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * Defines the animation that is applied on data changes.
 * @expose
 * @name animationOnDataChange
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "auto"
 * @ojvalue {string} "none"
 * @default <code class="prettyprint">"none"</code>
 */
/**
 * Defines the animation that is shown on initial display.
 * @expose
 * @name animationOnDisplay
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "auto"
 * @ojvalue {string} "none"
 * @default <code class="prettyprint">"none"</code>
 */
/**
 * Defines whether visual effects such as overlays are applied to the spark chart.
 * @expose
 * @name visualEffects
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "none"
 * @ojvalue {string} "auto"
 * @default <code class="prettyprint">"auto"</code>
 */
/**
 * Defines whether the axis baseline starts at the minimum value of the data or at zero.
 * @expose
 * @name baselineScaling
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "zero"
 * @ojvalue {string} "min"
 * @default <code class="prettyprint">"min"</code>
 */
/**
 * The width of the data line. Only applies to line spark charts.
 * @expose
 * @name lineWidth
 * @memberof oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The line style of the data line. Only applies to line spark charts.
 * @expose
 * @name lineStyle
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "dotted"
 * @ojvalue {string} "dashed"
 * @ojvalue {string} "solid"
 * @default <code class="prettyprint">"solid"</code>
 */
/**
 * The line type of the data line or area. Only applies to line and area spark charts.
 * @expose
 * @name lineType
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "curved"
 * @ojvalue {string} "stepped"
 * @ojvalue {string} "centeredStepped"
 * @ojvalue {string} "segmented"
 * @ojvalue {string} "centeredSegmented"
 * @ojvalue {string} "none"
 * @ojvalue {string} "straight"
 * @default <code class="prettyprint">"straight"</code>
 */
/**
 * The shape of the data markers. Only applies to line and area spark charts.
 * @expose
 * @name markerShape
 * @memberof oj.ojSparkChart
 * @instance
 * @type {string}
 * @ojvalue {string} "square"
 * @ojvalue {string} "circle"
 * @ojvalue {string} "diamond"
 * @ojvalue {string} "plus"
 * @ojvalue {string} "triangleDown"
 * @ojvalue {string} "triangleUp"
 * @ojvalue {string} "human"
 * @ojvalue {string} "auto"
 * @default <code class="prettyprint">"auto"</code>
 */
/**
 * The size of the data markers in pixels. Only applies to line and area spark charts.
 * @expose
 * @name markerSize
 * @memberof oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * Specifies the width of the bar gap as a ratio of the item width. The valid value is a number from 0 to 1.
 * @expose
 * @name barGapRatio
 * @memberof oj.ojSparkChart
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */