@oracle/oraclejet-core-pack 17.0.4 → 17.1.0

package/oj-c/Legend.json

@@ -19,12 +19,12 @@
     "ojtsvcomponent": true,
     "tstype": {
       "target": "Type",
-      "value": "interface CLegendElement<K extends string | number,D extends Item<K> | oj-c.Legend.Section<K> | any> extends JetElement<LegendElementSettableProperties<K,D>>"
+      "value": "interface CLegendElement<K extends string | number,D extends oj-c.Legend.Item<K> | oj-c.Legend.Section<K> | any> extends JetElement<LegendElementSettableProperties<K,D>>"
     },
     "ojsignature": [
       {
         "target": "Type",
-        "value": "interface CLegendElement<K extends string | number,D extends Item<K> | oj-c.Legend.Section<K> | any> extends JetElement<LegendElementSettableProperties<K,D>>"
+        "value": "interface CLegendElement<K extends string | number,D extends oj-c.Legend.Item<K> | oj-c.Legend.Section<K> | any> extends JetElement<LegendElementSettableProperties<K,D>>"
       }
     ],
     "since": "15.0.0",
@@ -63,7 +63,10 @@
       {
         "target": "Type",
         "value": "DataProvider<K, D>|null",
-        "jsdocOverride": true
+        "jsdocOverride": true,
+        "module": {
+          "DataProvider": "ojdataprovider"
+        }
       }
     ]
   },
@@ -392,7 +395,14 @@
       "names": [
         "object"
       ]
-    }
+    },
+    "tstype": [
+      {
+        "target": "Type",
+        "value": "Partial<Pick<CSSStyleDeclaration, \"color\" | \"fontFamily\" | \"fontSize\" | \"fontStyle\" | \"fontWeight\" | \"textDecoration\">>",
+        "jsdocOverride": true
+      }
+    ]
   },
   {
     "memberof": "oj-c.Legend",
@@ -579,7 +589,14 @@
       "names": [
         "object"
       ]
-    }
+    },
+    "tstype": [
+      {
+        "target": "Type",
+        "value": "Partial<Pick<CSSStyleDeclaration, \"color\" | \"fontFamily\" | \"fontSize\" | \"fontStyle\" | \"fontWeight\" | \"textDecoration\">>",
+        "jsdocOverride": true
+      }
+    ]
   },
   {
     "memberof": "oj-c.Legend",
@@ -867,8 +884,8 @@
           {
             "target": "Type",
             "value": "K",
-            "for": "id",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "id"
           }
         ]
       }
@@ -902,8 +919,8 @@
           {
             "target": "Type",
             "value": "D",
-            "for": "data",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "data"
           }
         ]
       },
@@ -920,8 +937,8 @@
           {
             "target": "Type",
             "value": "K",
-            "for": "key",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "key"
           }
         ]
       },
@@ -948,8 +965,8 @@
           {
             "target": "Type",
             "value": "Array<D>",
-            "for": "parentData",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "parentData"
           }
         ]
       },
@@ -966,8 +983,8 @@
           {
             "target": "Type",
             "value": "K",
-            "for": "parentKey",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "parentKey"
           }
         ]
       }
@@ -1001,8 +1018,8 @@
           {
             "target": "Type",
             "value": "D",
-            "for": "data",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "data"
           }
         ]
       },
@@ -1019,8 +1036,8 @@
           {
             "target": "Type",
             "value": "K",
-            "for": "key",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "key"
           }
         ]
       },
@@ -1051,12 +1068,12 @@
   },
   {
     "memberof": "oj-c.Legend",
-    "id": "oj-c.Legend.Section",
-    "name": "Section",
+    "id": "oj-c.Legend.Item",
+    "name": "Item",
     "kind": "typedef",
-    "longname": "oj-c.Legend.Section",
+    "longname": "oj-c.Legend.Item",
     "scope": "static",
-    "description": "Object type that defines a section data item.",
+    "description": "Object type that defines a legend data item.",
     "tsgenerictype": {
       "target": "Type",
       "value": "<K>",
@@ -1074,7 +1091,7 @@
     "properties": [
       {
         "name": "id",
-        "description": "The id of the legend section. For the DataProvider case, the key for the node will be used as the id.",
+        "description": "The id of the legend item.",
         "optional": false,
         "type": {
           "names": [
@@ -1085,54 +1102,193 @@
           {
             "target": "Type",
             "value": "K",
-            "for": "id",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "id"
           }
         ]
       },
       {
-        "name": "items",
-        "description": "The id of the legend section. For the DataProvider case, the key for the node will be used as the id.",
+        "name": "text",
+        "description": "The legend item text. Also used as item aria label if short-desc is not provided.",
         "optional": false,
         "type": {
           "names": [
-            "Array<object>"
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "categories",
+        "description": "An array of categories for the legend item. Legend items currently only support a single category.",
+        "optional": true,
+        "type": {
+          "names": [
+            "Array<string>"
+          ]
+        }
+      },
+      {
+        "name": "symbolType",
+        "description": "The type of legend symbol to display.",
+        "optional": true,
+        "type": {
+          "names": [
+            "\"marker\"",
+            "\"image\"",
+            "\"line\"",
+            "\"lineWithMarker\""
           ]
         },
-        "tstype": [
+        "ojvalues": [
           {
-            "target": "Type",
-            "value": "Array<({ id: K; } & LegendItemProps)>",
-            "for": "items",
-            "jsdocOverride": true,
-            "module": {
-              "Item": "ojdataprovider"
+            "name": "line",
+            "description": "The legend symbol will be a line.",
+            "displayName": "Line",
+            "type": {
+              "names": [
+                "string"
+              ]
+            }
+          },
+          {
+            "name": "lineWithMarker",
+            "description": "The legend symbol will be a line and a marker.",
+            "displayName": "LineWithMarker",
+            "type": {
+              "names": [
+                "string"
+              ]
+            }
+          },
+          {
+            "name": "image",
+            "description": "The legend symbol will be an image.",
+            "displayName": "Image",
+            "type": {
+              "names": [
+                "string"
+              ]
+            }
+          },
+          {
+            "name": "marker",
+            "description": "The legend symbol will be a marker.",
+            "displayName": "Marker",
+            "type": {
+              "names": [
+                "string"
+              ]
             }
           }
-        ],
-        "properties": [
+        ]
+      },
+      {
+        "name": "source",
+        "description": "The URI of the image of the legend symbol.",
+        "optional": true,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "color",
+        "description": "The color of the legend symbol (line or marker). When symbolType is \"lineWithMarker\", this attribute defines the line color and the markerColor attribute defines the marker color.",
+        "optional": true,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "borderColor",
+        "description": "The border color of the marker. Only applies if symbolType is \"marker\" or \"lineWithMarker",
+        "optional": true,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "lineStyle",
+        "description": "The line style. Only applies when the symbolType is \"line\" or \"lineWithMarker\".",
+        "optional": true,
+        "type": {
+          "names": [
+            "\"dashed\"",
+            "\"solid\"",
+            "\"dotted\""
+          ]
+        },
+        "ojvalues": [
           {
-            "name": "id",
-            "description": "The id of the legend item.",
-            "optional": false,
+            "name": "dotted",
+            "description": "Line will have dotted strokes.",
+            "displayName": "Dotted",
             "type": {
               "names": [
-                "any"
+                "string"
               ]
-            },
-            "tstype": [
-              {
-                "target": "Type",
-                "value": "K",
-                "for": "id",
-                "jsdocOverride": true
-              }
-            ]
+            }
           },
           {
-            "name": "text",
-            "description": "The legend item text. Also used as item aria label if short-desc is not provided.",
-            "optional": false,
+            "name": "dashed",
+            "description": "Line will have dashed strokes.",
+            "displayName": "Dashed",
+            "type": {
+              "names": [
+                "string"
+              ]
+            }
+          },
+          {
+            "name": "solid",
+            "description": "Line will have a solid stroke.",
+            "displayName": "Solid",
+            "type": {
+              "names": [
+                "string"
+              ]
+            }
+          }
+        ]
+      },
+      {
+        "name": "lineWidth",
+        "description": "The line width in pixels. Only applies when the symbolType is \"line\" or \"lineWithMarker.",
+        "optional": true,
+        "type": {
+          "names": [
+            "number"
+          ]
+        }
+      },
+      {
+        "name": "markerShape",
+        "description": "The shape of the marker. Only applies if symbolType is \"marker\" or \"lineWithMarker\". Does not apply if a custom image is specified.",
+        "optional": true,
+        "type": {
+          "names": [
+            "\"square\"",
+            "\"circle\"",
+            "\"ellipse\"",
+            "\"diamond\"",
+            "\"human\"",
+            "\"plus\"",
+            "\"star\"",
+            "\"triangleDown\"",
+            "\"triangleUp\"",
+            "\"rectangle\""
+          ]
+        },
+        "ojvalues": [
+          {
+            "name": "circle",
+            "description": "The marker will be of circular shape.",
+            "displayName": "Circle",
             "type": {
               "names": [
                 "string"
@@ -1140,74 +1296,29 @@
             }
           },
           {
-            "name": "categories",
-            "description": "An array of categories for the legend item. Legend items currently only support a single category.",
-            "optional": true,
+            "name": "diamond",
+            "description": "The marker will be of diamond shape.",
+            "displayName": "Diamond",
             "type": {
               "names": [
-                "Array<string>"
+                "string"
               ]
             }
           },
           {
-            "name": "symbolType",
-            "description": "The type of legend symbol to display.",
-            "optional": true,
+            "name": "ellipse",
+            "description": "The marker will be of ellipse shape.",
+            "displayName": "Ellipse",
             "type": {
               "names": [
-                "\"marker\"",
-                "\"image\"",
-                "\"line\"",
-                "\"lineWithMarker\""
+                "string"
               ]
-            },
-            "ojvalues": [
-              {
-                "name": "line",
-                "description": "The legend symbol will be a line.",
-                "displayName": "Line",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "lineWithMarker",
-                "description": "The legend symbol will be a line and a marker.",
-                "displayName": "LineWithMarker",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "image",
-                "description": "The legend symbol will be an image.",
-                "displayName": "Image",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "marker",
-                "description": "The legend symbol will be a marker.",
-                "displayName": "Marker",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              }
-            ]
+            }
           },
           {
-            "name": "source",
-            "description": "The URI of the image of the legend symbol.",
-            "optional": true,
+            "name": "human",
+            "description": "The marker will be of human shape.",
+            "displayName": "Human",
             "type": {
               "names": [
                 "string"
@@ -1215,9 +1326,9 @@
             }
           },
           {
-            "name": "color",
-            "description": "The color of the legend symbol (line or marker). When symbolType is \"lineWithMarker\", this attribute defines the line color and the markerColor attribute defines the marker color.",
-            "optional": true,
+            "name": "plus",
+            "description": "The marker will be of plus shape.",
+            "displayName": "Plus",
             "type": {
               "names": [
                 "string"
@@ -1225,9 +1336,9 @@
             }
           },
           {
-            "name": "borderColor",
-            "description": "The border color of the marker. Only applies if symbolType is \"marker\" or \"lineWithMarker",
-            "optional": true,
+            "name": "rectangle",
+            "description": "The marker will be of rectangular shape.",
+            "displayName": "Rectangle",
             "type": {
               "names": [
                 "string"
@@ -1235,184 +1346,83 @@
             }
           },
           {
-            "name": "lineStyle",
-            "description": "The line style. Only applies when the symbolType is \"line\" or \"lineWithMarker\".",
-            "optional": true,
+            "name": "square",
+            "description": "The marker will be of square shape.",
+            "displayName": "Square",
             "type": {
               "names": [
-                "\"dashed\"",
-                "\"solid\"",
-                "\"dotted\""
+                "string"
               ]
-            },
-            "ojvalues": [
-              {
-                "name": "dotted",
-                "description": "Line will have dotted strokes.",
-                "displayName": "Dotted",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "dashed",
-                "description": "Line will have dashed strokes.",
-                "displayName": "Dashed",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "solid",
-                "description": "Line will have a solid stroke.",
-                "displayName": "Solid",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              }
-            ]
+            }
           },
           {
-            "name": "lineWidth",
-            "description": "The line width in pixels. Only applies when the symbolType is \"line\" or \"lineWithMarker.",
-            "optional": true,
+            "name": "star",
+            "description": "The marker will be of star shape.",
+            "displayName": "Star",
             "type": {
               "names": [
-                "number"
+                "string"
               ]
             }
           },
           {
-            "name": "markerShape",
-            "description": "The shape of the marker. Only applies if symbolType is \"marker\" or \"lineWithMarker\". Does not apply if a custom image is specified.",
-            "optional": true,
+            "name": "triangleDown",
+            "description": "The  marker will be of triangular shape facing down.",
+            "displayName": "Triangle Down",
             "type": {
               "names": [
-                "\"square\"",
-                "\"circle\"",
-                "\"ellipse\"",
-                "\"diamond\"",
-                "\"human\"",
-                "\"plus\"",
-                "\"star\"",
-                "\"triangleDown\"",
-                "\"triangleUp\"",
-                "\"rectangle\""
+                "string"
               ]
-            },
-            "ojvalues": [
-              {
-                "name": "circle",
-                "description": "The marker will be of circular shape.",
-                "displayName": "Circle",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "diamond",
-                "description": "The marker will be of diamond shape.",
-                "displayName": "Diamond",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "ellipse",
-                "description": "The marker will be of ellipse shape.",
-                "displayName": "Ellipse",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "human",
-                "description": "The marker will be of human shape.",
-                "displayName": "Human",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "plus",
-                "description": "The marker will be of plus shape.",
-                "displayName": "Plus",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "rectangle",
-                "description": "The marker will be of rectangular shape.",
-                "displayName": "Rectangle",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "square",
-                "description": "The marker will be of square shape.",
-                "displayName": "Square",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "star",
-                "description": "The marker will be of star shape.",
-                "displayName": "Star",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "triangleDown",
-                "description": "The  marker will be of triangular shape facing down.",
-                "displayName": "Triangle Down",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "triangleUp",
-                "description": "The  marker will be of triangular shape facing up.",
-                "displayName": "Triangle Up",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              }
-            ]
+            }
           },
           {
-            "name": "markerColor",
-            "description": "The color of the marker, if different than the line color. Only applies if the symbolType is \"lineWithMarker\".",
-            "optional": true,
+            "name": "triangleUp",
+            "description": "The  marker will be of triangular shape facing up.",
+            "displayName": "Triangle Up",
+            "type": {
+              "names": [
+                "string"
+              ]
+            }
+          }
+        ]
+      },
+      {
+        "name": "markerColor",
+        "description": "The color of the marker, if different than the line color. Only applies if the symbolType is \"lineWithMarker\".",
+        "optional": true,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "shortDesc",
+        "description": "The description of this legend item. This is used for accessibility and for customizing the tooltip text.",
+        "optional": true,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "drilling",
+        "description": "Whether drilling is enabled on the legend item. Drillable objects will show a pointer cursor on hover and fire ojDrill event on click. To enable drilling for all legend items at once, use the drilling attribute in the top level.",
+        "optional": true,
+        "type": {
+          "names": [
+            "\"inherit\"",
+            "\"off\"",
+            "\"on\""
+          ]
+        },
+        "ojvalues": [
+          {
+            "name": "inherit",
+            "description": "The drilling behavior is inherited from legend.",
+            "displayName": "Inherit",
             "type": {
               "names": [
                 "string"
@@ -1420,9 +1430,9 @@
             }
           },
           {
-            "name": "shortDesc",
-            "description": "The description of this legend item. This is used for accessibility and for customizing the tooltip text.",
-            "optional": true,
+            "name": "off",
+            "description": "The legend item will not be drillable.",
+            "displayName": "Off",
             "type": {
               "names": [
                 "string"
@@ -1430,48 +1440,75 @@
             }
           },
           {
-            "name": "drilling",
-            "description": "Whether drilling is enabled on the legend item. Drillable objects will show a pointer cursor on hover and fire ojDrill event on click. To enable drilling for all legend items at once, use the drilling attribute in the top level.",
-            "optional": true,
+            "name": "on",
+            "description": "The legend item will be drillable.",
+            "displayName": "On",
             "type": {
               "names": [
-                "\"inherit\"",
-                "\"off\"",
-                "\"on\""
+                "string"
               ]
-            },
-            "ojvalues": [
-              {
-                "name": "inherit",
-                "description": "The drilling behavior is inherited from legend.",
-                "displayName": "Inherit",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "off",
-                "description": "The legend item will not be drillable.",
-                "displayName": "Off",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              },
-              {
-                "name": "on",
-                "description": "The legend item will be drillable.",
-                "displayName": "On",
-                "type": {
-                  "names": [
-                    "string"
-                  ]
-                }
-              }
-            ]
+            }
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.Legend",
+    "id": "oj-c.Legend.Section",
+    "name": "Section",
+    "kind": "typedef",
+    "longname": "oj-c.Legend.Section",
+    "scope": "static",
+    "description": "Object type that defines a section data item.",
+    "tsgenerictype": {
+      "target": "Type",
+      "value": "<K>",
+      "for": "genericTypeParameters"
+    },
+    "type": {
+      "names": [
+        "Object"
+      ]
+    },
+    "meta": {
+      "filename": "legend.tsx",
+      "path": "web/components/oj-c/legend"
+    },
+    "properties": [
+      {
+        "name": "id",
+        "description": "The id of the legend section. For the DataProvider case, the key for the node will be used as the id.",
+        "optional": false,
+        "type": {
+          "names": [
+            "any"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "K",
+            "jsdocOverride": true,
+            "for": "id"
+          }
+        ]
+      },
+      {
+        "name": "items",
+        "description": "The id of the legend section. For the DataProvider case, the key for the node will be used as the id.",
+        "optional": false,
+        "type": {
+          "names": [
+            "Array<object>"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "Array<oj-c.Legend.Item<K>>",
+            "jsdocOverride": true,
+            "for": "items"
           }
         ]
       },