@oracle/oraclejet-core-pack 14.0.0

package/oj-c/RatingGauge.json

@@ -0,0 +1,495 @@
+[
+  {
+    "pack": "oj-c",
+    "id": "oj-c.RatingGauge",
+    "name": "RatingGauge",
+    "memberof": "oj-c",
+    "longname": "oj-c.RatingGauge",
+    "kind": "class",
+    "classdesc": "<h3 id=\"ratingGaugeOverview-section\">\n  JET Rating Gauge\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#ratingGaugeOverview-section\"></a>\n</h3>\nRating gauges are typically used to display or accept user feedback on a product or service.\n<pre class=\"prettyprint\"><code>&lt;oj-c-rating-gauge value='4'>&lt;/oj-c-rating-gauge></code></pre>\n\n<h3 id=\"a11y-section\">\n  Accessibility\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#a11y-section\"></a>\n</h3>\n<p>\nThe application is strongly encouraged, even though it is not required, to populate the aria-label attribute on the element with meaningful descriptors as\nthe oj-c-rating-gauge element does not provide a default descriptor.\n</p>\n<p>\nDisabled content: JET supports an accessible luminosity contrast ratio,\nas specified in <a href=\"http://www.w3.org/TR/WCAG20/#visual-audio-contrast-contrast\">WCAG 2.0 - Section 1.4.3 \"Contrast\"</a>,\nin the themes that are accessible.  (See the \"Theming\" chapter of the JET Developer Guide for more information on which\nthemes are accessible.)  Note that Section 1.4.3 says that text or images of text that are part of an inactive user\ninterface component have no contrast requirement.  Because disabled content may not meet the minimum contrast ratio\nrequired of enabled content, it cannot be used to convey meaningful information.\n</p>\n\n<h3 id=\"keyboardSection\">\n  Keyboard\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#keyboardSection\"></a>\n</h3>\n\n<table class=\"keyboard-table\">\n  <thead>\n    <tr>\n      <th>Key</th>\n      <th>Action</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td><kbd>Enter</kbd></td>\n      <td>Submit the current value of the gauge.</td>\n    </tr>\n    <tr>\n      <td><kbd>Tab</kbd></td>\n      <td>Move focus to next element and submit the current value of the gauge.</td>\n    </tr>\n    <tr>\n      <td><kbd>Shift + Tab</kbd></td>\n      <td>Move focus to previous element.</td>\n    </tr>\n    <tr>\n      <td><kbd>End</kbd></td>\n      <td>Increase the gauge's transient value to max value. Value is set after using <kbd>Enter</kbd> or <kbd>Tab</kbd> to submit.</td>\n    </tr>\n    <tr>\n      <td><kbd>Home</kbd></td>\n      <td>Decrease the gauge's transient value to zero. Value is set after using <kbd>Enter</kbd> or <kbd>Tab</kbd> to submit.</td>\n    </tr>\n    <tr>\n      <td><kbd>LeftArrow</kbd></td>\n      <td>Decrease the gauge's transient value in left-to-right locales. Increase the gauge's transient value in right-to-left locales. Value is set after using <kbd>Enter</kbd> or <kbd>Tab</kbd> to submit.</td>\n    </tr>\n    <tr>\n      <td><kbd>RightArrow</kbd></td>\n      <td>Increase the gauge's transient value in left-to-right locales. Decrease the gauge's transient value in right-to-left locales. Value is set after using <kbd>Enter</kbd> or <kbd>Tab</kbd> to submit.</td>\n    </tr>\n  </tbody>\n</table>\n\n<h3 id=\"touch-section\">\nTouch End User Information\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#touch-section\"></a>\n</h3>\n\n<table class=\"keyboard-table\">\n  <thead>\n    <tr>\n      <th>Gesture</th>\n      <th>Action</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td><kbd>Press and Hold</kbd></td>\n      <td>Activate tooltip or datatip.</td>\n    </tr>\n    <tr>\n      <td><kbd>Drag</kbd></td>\n      <td>Value change when <code class=\"prettyprint\">readonly</code> or <code class=\"prettyprint\">disabled</code> is <code class=\"prettyprint\">false</code>.</td>\n    </tr>\n  </tbody>\n</table>",
+    "scope": "static",
+    "tagWithoutBrackets": "oj-c-rating-gauge",
+    "tagWithBrackets": "<oj-c-rating-gauge>",
+    "domInterface": "CRatingGaugeElement",
+    "ojPageTitle": "&lt;oj-c-rating-gauge>",
+    "ojcomponent": true,
+    "isvcomponent": true,
+    "camelCaseName": "RatingGauge",
+    "ojPageTitlePrefix": "Element: ",
+    "ojtsvcomponent": true,
+    "tstype": {
+      "target": "Type",
+      "value": "interface CRatingGaugeElement extends JetElement<RatingGaugeElementSettableProperties>"
+    },
+    "ojsignature": [
+      {
+        "target": "Type",
+        "value": "interface CRatingGaugeElement extends JetElement<RatingGaugeElementSettableProperties>"
+      }
+    ],
+    "since": "13.0.0",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "ojmodule": "rating-gauge"
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#max",
+    "name": "max",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#max",
+    "optional": true,
+    "scope": "instance",
+    "description": "Integer value specifying the maximum value of the gauge, which determines the number of items that are displayed.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "defaultvalue": 5,
+    "type": {
+      "names": [
+        "number"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#readonly",
+    "name": "readonly",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#readonly",
+    "optional": true,
+    "scope": "instance",
+    "description": "Defines whether the value of the gauge can be changed by the end user.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "defaultvalue": false,
+    "type": {
+      "names": [
+        "boolean"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#disabled",
+    "name": "disabled",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#disabled",
+    "optional": true,
+    "scope": "instance",
+    "description": "Defines whether the gauge is disabled or not. User interaction is prevented and the rating gauge is hidden from screen readers if set to true.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "defaultvalue": false,
+    "type": {
+      "names": [
+        "boolean"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#changed",
+    "name": "changed",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#changed",
+    "optional": true,
+    "scope": "instance",
+    "ojwriteback": true,
+    "description": "Whether there has been a value entered by the user even if it is the same as the initial value.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "defaultvalue": false,
+    "type": {
+      "names": [
+        "boolean"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#value",
+    "name": "value",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#value",
+    "optional": true,
+    "scope": "instance",
+    "ojwriteback": true,
+    "description": "The value of the Rating Gauge. The element's value attribute is used if it\nis provided, otherwise the default value of 0 is used.\nAny other negative value will default to 0.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "defaultvalue": 0,
+    "type": {
+      "names": [
+        "number|null"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#step",
+    "name": "step",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#step",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies the increment by which values can be changed by the end user.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "defaultvalue": 1,
+    "type": {
+      "names": [
+        "number"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#describedBy",
+    "name": "describedBy",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#describedBy",
+    "optional": true,
+    "scope": "instance",
+    "description": "Used to establish a relationship between this component and another element.\nTo facilitate correct screen reader behavior, the described-by attribute is\ncopied to the aria-describedby attribute on the component's dom.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "type": {
+      "names": [
+        "string|null"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#labelledBy",
+    "name": "labelledBy",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#labelledBy",
+    "optional": true,
+    "scope": "instance",
+    "description": "Used to establish a relationship between this component and another element.\nA common use is to tie a label, which a text in a div or some other HTML element, and the oj-c-rating-gauge together for accessibility.\nThe label element has an id, which is used by the labelled-by attribute to tie the two components together to facilitate correct screen reader behavior.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "type": {
+      "names": [
+        "string|null"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#size",
+    "name": "size",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#size",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies the size of the individual rating gauge items.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "ojvalues": [
+      {
+        "name": "sm",
+        "description": "small Rating Gauge",
+        "displayName": "Small",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "md",
+        "description": "medium Rating Gauge (default, if unspecified)",
+        "displayName": "Medium",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "lg",
+        "description": "large Rating Gauge",
+        "displayName": "Large",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      }
+    ],
+    "defaultvalue": "\"md\"",
+    "type": {
+      "names": [
+        "\"sm\"",
+        "\"md\"",
+        "\"lg\""
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#color",
+    "name": "color",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#color",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies the color of the individual rating gauge items.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "ojvalues": [
+      {
+        "name": "neutral",
+        "description": "neutral color Rating Gauge (default, if unspecified)",
+        "displayName": "Neutral",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "gold",
+        "description": "gold color Rating Gauge",
+        "displayName": "Gold",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      }
+    ],
+    "defaultvalue": "\"neutral\"",
+    "type": {
+      "names": [
+        "\"neutral\"",
+        "\"gold\""
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#datatip",
+    "name": "datatip",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#datatip",
+    "optional": true,
+    "scope": "instance",
+    "description": "The rating gauge datatip string. Datatip is only used for interactive rating gauges.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "type": {
+      "names": [
+        "function"
+      ]
+    },
+    "tstype": [
+      {
+        "target": "Type",
+        "value": "(context: DatatipContext) => string",
+        "jsdocOverride": true
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#tooltip",
+    "name": "tooltip",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#tooltip",
+    "optional": true,
+    "scope": "instance",
+    "description": "The rating gauge tooltip. Tooltip is only used for read only rating gauges. If aria-label is not specified, tooltip will be used as the aria-label.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "type": {
+      "names": [
+        "string"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#transientValue",
+    "name": "transientValue",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge#transientValue",
+    "optional": true,
+    "scope": "instance",
+    "ojwriteback": true,
+    "readonly": true,
+    "description": "A read-only property for retrieving the transient value from the rating gauge. It is updated upon user gestures that cause transient value changes, such as hovering over the rating gauge.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "type": {
+      "names": [
+        "number"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#setProperty",
+    "name": "setProperty",
+    "kind": "function",
+    "longname": "oj-c.RatingGauge#setProperty",
+    "description": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "scope": "instance",
+    "params": [
+      {
+        "name": "property",
+        "description": "The property name to set. Supports dot notation for subproperty access.",
+        "type": "string"
+      },
+      {
+        "name": "value",
+        "description": "The new value to set the property to.",
+        "type": "any"
+      }
+    ],
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "void"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#getProperty",
+    "name": "getProperty",
+    "kind": "function",
+    "longname": "oj-c.RatingGauge#getProperty",
+    "description": "Retrieves the value of a property or a subproperty.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "scope": "instance",
+    "params": [
+      {
+        "name": "property",
+        "description": "The property name to get. Supports dot notation for subproperty access.",
+        "type": "string"
+      }
+    ],
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "any"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge#setProperties",
+    "name": "setProperties",
+    "kind": "function",
+    "longname": "oj-c.RatingGauge#setProperties",
+    "description": "Performs a batch set of properties.",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "scope": "instance",
+    "params": [
+      {
+        "name": "properties",
+        "description": "An object containing the property and value pairs to set.",
+        "type": "object"
+      }
+    ],
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "void"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "id": "oj-c.RatingGauge.touchDoc",
+    "name": "touchDoc",
+    "kind": "member",
+    "longname": "oj-c.RatingGauge.touchDoc",
+    "description": "<table class=\"keyboard-table\">\n  <thead>\n    <tr>\n      <th>Gesture</th>\n      <th>Action</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td><kbd>Press and Hold</kbd></td>\n      <td>Activate tooltip or datatip.</td>\n    </tr>\n    <tr>\n      <td><kbd>Drag</kbd></td>\n      <td>Value change when <code class=\"prettyprint\">readonly</code> or <code class=\"prettyprint\">disabled</code> is <code class=\"prettyprint\">false</code>.</td>\n    </tr>\n  </tbody>\n</table>",
+    "memberof": "oj-c.RatingGauge",
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "ojfragment": true
+  },
+  {
+    "memberof": "oj-c.RatingGauge",
+    "id": "oj-c.RatingGauge.DatatipContext",
+    "name": "DatatipContext",
+    "kind": "typedef",
+    "longname": "oj-c.RatingGauge.DatatipContext",
+    "scope": "static",
+    "description": "Context for datatip function.",
+    "type": {
+      "names": [
+        "Object"
+      ]
+    },
+    "meta": {
+      "filename": "rating-gauge.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/rating-gauge"
+    },
+    "properties": [
+      {
+        "name": "value",
+        "description": "The value of the currently active rating gauge item.",
+        "optional": false,
+        "type": {
+          "names": [
+            "number"
+          ]
+        }
+      }
+    ]
+  }
+]