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

Oracle® JavaScript Extension Toolkit (JET)
1.1.2

E65298-01

/**
 * The metric value.
 * @expose
 * @name value
 * @memberof oj.ojLedGauge
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The minimum value of the gauge.
 * @expose
 * @name min
 * @memberof oj.ojLedGauge
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The maximum value of the gauge.
 * @expose
 * @name max
 * @memberof oj.ojLedGauge
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The rotation angle for the gauge. Useful for changing the direction of triangle or arrow gauges.
 * @expose
 * @name rotation
 * @memberof oj.ojLedGauge
 * @instance
 * @type {number}
 * @ojvalue {number} 90
 * @ojvalue {number} 180
 * @ojvalue {number} 270
 * @ojvalue {number} 0
 * @default <code class="prettyprint">0</code>
 */
/**
 * Fraction of area to use. Values range from 0 to 1.
 * @expose
 * @name size
 * @memberof oj.ojLedGauge
 * @instance
 * @type {number}
 * @default <code class="prettyprint">1</code>
 */
/**
 * An array of objects with the following properties defining the thresholds for the gauge.
 * @expose
 * @name thresholds
 * @memberof oj.ojLedGauge
 * @instance
 * @type {Array.<Object>}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The upper bound of the threshold. This value is ignored for the final threshold, which uses the maximum value of the gauge.
 * @expose
 * @name thresholds[].max
 * @memberof! oj.ojLedGauge
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The color of the threshold.
 * @expose
 * @name thresholds[].color
 * @memberof! oj.ojLedGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color of the threshold.
 * @expose
 * @name thresholds[].borderColor
 * @memberof! oj.ojLedGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * Specific description for the threshold and overwrites the shortDesc specified on gauge. This is used for accessibility and also for customizing the tooltip text.
 * @expose
 * @name thresholds[].shortDesc
 * @memberof! oj.ojLedGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The shape of the led gauge.
 * @expose
 * @name type
 * @memberof oj.ojLedGauge
 * @instance
 * @type {string}
 * @ojvalue {string} "arrow"
 * @ojvalue {string} "diamond"
 * @ojvalue {string} "rectangle"
 * @ojvalue {string} "triangle"
 * @ojvalue {string} "star"
 * @ojvalue {string} "human"
 * @ojvalue {string} "circle"
 * @default <code class="prettyprint">"circle"</code>
 */
/**
 * The color of the gauge. Only applies when thresholds are not defined.
 * @expose
 * @name color
 * @memberof oj.ojLedGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color of the gauge. Only applies when thresholds are not defined.
 * @expose
 * @name borderColor
 * @memberof oj.ojLedGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object defining the value label.
 * @expose
 * @name metricLabel
 * @memberof oj.ojLedGauge
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining the style of the label.
 * @expose
 * @name metricLabel.style
 * @memberof! oj.ojLedGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * Defines whether the label is a number or a percentage of the total value.
 * @expose
 * @name metricLabel.textType
 * @memberof! oj.ojLedGauge
 * @instance
 * @type {string}
 * @ojvalue {string} "percent"
 * @ojvalue {string} "number"
 * @default <code class="prettyprint">"number"</code>
 */
/**
 * Defines if the label is rendered.
 * @expose
 * @name metricLabel.rendered
 * @memberof! oj.ojLedGauge
 * @instance
 * @type {string}
 * @ojvalue {string} "on"
 * @ojvalue {string} "off"
 * @default <code class="prettyprint">"off"</code>
 */
/**
 * The scaling behavior of the labels. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
 * @expose
 * @name metricLabel.scaling
 * @memberof! oj.ojLedGauge
 * @instance
 * @type {string}
 * @ojvalue {string} "none"
 * @ojvalue {string} "thousand"
 * @ojvalue {string} "million"
 * @ojvalue {string} "billion"
 * @ojvalue {string} "trillion"
 * @ojvalue {string} "quadrillion"
 * @ojvalue {string} "auto"
 * @default <code class="prettyprint">"auto"</code>
 */
/**
 * The converter used to format the labels. When using a converter, scaling should be set to none, as the formatted result may not be compatible with the scaling suffixes.
 * @expose
 * @name metricLabel.converter
 * @memberof! oj.ojLedGauge
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The text for the label. If specified, text will overwrite the numeric value that is displayed by default. The converter, scaling, and textType attributes are ignored when text is specified.
 * @expose
 * @name metricLabel.text
 * @memberof! oj.ojLedGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * An object defining the title.
 * @expose
 * @name title
 * @memberof oj.ojLedGauge
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The CSS style string defining the style of the title.
 * @expose
 * @name title.style
 * @memberof! oj.ojLedGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The text for the title.
 * @expose
 * @name title.text
 * @memberof! oj.ojLedGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * Defines whether visual effects such as overlays are applied to the gauge.
 * @expose
 * @name visualEffects
 * @memberof oj.ojLedGauge
 * @instance
 * @type {string}
 * @ojvalue {string} "none"
 * @ojvalue {string} "auto"
 * @default <code class="prettyprint">"auto"</code>
 */