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

/**
 * The value set on the gauge.
 * @expose
 * @name value
 * @memberof oj.ojRatingGauge
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * Integer value specifying the maximum value of the gauge, which determines the number of shapes or images that are displayed.
 * @expose
 * @name max
 * @memberof oj.ojRatingGauge
 * @instance
 * @type {number}
 * @default <code class="prettyprint">5</code>
 */
/**
 * The minimum value that can be set on the gauge by the end user. Does not affect the value set on the gauge by API.
 * @expose
 * @name min
 * @memberof oj.ojRatingGauge
 * @instance
 * @type {number}
 * @default <code class="prettyprint">0</code>
 */
/**
 * Whether there has been a value entered by the user.
 * @expose
 * @name changed
 * @memberof oj.ojRatingGauge
 * @instance
 * @type {boolean}
 * @default <code class="prettyprint">false</code>
 */
/**
 * An array of objects with the following properties defining the thresholds for the gauge.
 * @expose
 * @name thresholds
 * @memberof oj.ojRatingGauge
 * @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.ojRatingGauge
 * @instance
 * @type {number}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The color of the threshold.
 * @expose
 * @name thresholds[].color
 * @memberof! oj.ojRatingGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color of the threshold.
 * @expose
 * @name thresholds[].borderColor
 * @memberof! oj.ojRatingGauge
 * @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.ojRatingGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The unselected shape for the gauge.
 * @expose
 * @name unselectedState
 * @memberof oj.ojRatingGauge
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * For choosing a built-in shape
 * @expose
 * @name unselectedState.shape
 * @memberof! oj.ojRatingGauge
 * @instance
 * @type {string}
 * @ojvalue {string} "circle"
 * @ojvalue {string} "rectangle"
 * @ojvalue {string} "diamond"
 * @ojvalue {string} "triangle"
 * @ojvalue {string} "human"
 * @ojvalue {string} "dot"
 * @ojvalue {string} "none"
 * @ojvalue {string} "star"
 * @default <code class="prettyprint">"star"</code>
 */
/**
 * The color for unselected state.
 * @expose
 * @name unselectedState.color
 * @memberof! oj.ojRatingGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color for unselected state.
 * @expose
 * @name unselectedState.borderColor
 * @memberof! oj.ojRatingGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The selected shape for the gauge.
 * @expose
 * @name selectedState
 * @memberof oj.ojRatingGauge
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * For choosing a built-in shape.
 * @expose
 * @name selectedState.shape
 * @memberof! oj.ojRatingGauge
 * @instance
 * @type {string}
 * @ojvalue {string} "circle"
 * @ojvalue {string} "rectangle"
 * @ojvalue {string} "diamond"
 * @ojvalue {string} "triangle"
 * @ojvalue {string} "human"
 * @ojvalue {string} "star"
 * @default <code class="prettyprint">"star"</code>
 */
/**
 * The color for selected state.
 * @expose
 * @name selectedState.color
 * @memberof! oj.ojRatingGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color for selected state.
 * @expose
 * @name selectedState.borderColor
 * @memberof! oj.ojRatingGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The shape that displays on hover.
 * @expose
 * @name hoverState
 * @memberof oj.ojRatingGauge
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * For choosing a built-in shape.
 * @expose
 * @name hoverState.shape
 * @memberof! oj.ojRatingGauge
 * @instance
 * @type {string}
 * @ojvalue {string} "circle"
 * @ojvalue {string} "rectangle"
 * @ojvalue {string} "diamond"
 * @ojvalue {string} "triangle"
 * @ojvalue {string} "human"
 * @ojvalue {string} "star"
 * @default <code class="prettyprint">"star"</code>
 */
/**
 * The color for hover state.
 * @expose
 * @name hoverState.color
 * @memberof! oj.ojRatingGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color for hover state.
 * @expose
 * @name hoverState.borderColor
 * @memberof! oj.ojRatingGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The changed shape for the gauge. Displayed after the user has set a value, or when the changed attribute of the data object is set to true.
 * @expose
 * @name changedState
 * @memberof oj.ojRatingGauge
 * @instance
 * @type {object}
 * @default <code class="prettyprint">null</code>
 */
/**
 * For choosing a built-in shape.
 * @expose
 * @name changedState.shape
 * @memberof! oj.ojRatingGauge
 * @instance
 * @type {string}
 * @ojvalue {string} "circle"
 * @ojvalue {string} "rectangle"
 * @ojvalue {string} "diamond"
 * @ojvalue {string} "triangle"
 * @ojvalue {string} "human"
 * @ojvalue {string} "star"
 * @default <code class="prettyprint">"star"</code>
 */
/**
 * The color for changed state.
 * @expose
 * @name changedState.color
 * @memberof! oj.ojRatingGauge
 * @instance
 * @type {string}
 * @default <code class="prettyprint">null</code>
 */
/**
 * The border color for changed state.
 * @expose
 * @name changedState.borderColor
 * @memberof! oj.ojRatingGauge
 * @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.ojRatingGauge
 * @instance
 * @type {string}
 * @ojvalue {string} "none"
 * @ojvalue {string} "auto"
 * @default <code class="prettyprint">"auto"</code>
 */
/**
 * Specifies the increment by which values can be specified by the end user.
 * @expose
 * @name step
 * @memberof oj.ojRatingGauge
 * @instance
 * @type {number}
 * @ojvalue {number} 0.5
 * @ojvalue {number} 1
 * @default <code class="prettyprint">1</code>
 */
/**
 * Defines the type of rating gauge to be rendered.
 * @expose
 * @name orientation
 * @memberof oj.ojRatingGauge
 * @instance
 * @type {string}
 * @ojvalue {string} "vertical"
 * @ojvalue {string} "horizontal"
 * @default <code class="prettyprint">"horizontal"</code>
 */
/**
 * Defines whether the value of the gauge can be changed by the end user.
 * @expose
 * @name readOnly
 * @memberof oj.ojRatingGauge
 * @instance
 * @type {boolean}
 * @default <code class="prettyprint">true</code>
 */