Skip to content

Commit

Permalink
chore: set since tag
Browse files Browse the repository at this point in the history
  • Loading branch information
@Caele
Caele committed Sep 16, 2021
1 parent 209f79d commit f182372
Show file tree
Hide file tree
Showing 3 changed files with 126 additions and 119 deletions.
1 change: 1 addition & 0 deletions apis/nucleus/src/components/Footer.jsx
View file
Expand Up @@ -5,6 +5,7 @@ import { makeStyles, Typography, Grid } from '@material-ui/core';
/**
* @interface
* @extends HTMLElement
* @since 2.0.0
*/
const CellFooter = {
/** @type {'njs-cell-footer'} */
Expand Down
2 changes: 2 additions & 0 deletions apis/nucleus/src/components/Header.jsx
View file
Expand Up @@ -13,6 +13,7 @@ const MIN_WIDTH = (ITEM_WIDTH + ITEM_SPACING) * NUMBER_OF_ITEMS + DIVIDER + ITEM
/**
* @interface
* @extends HTMLElement
* @since 2.0.0
*/
const CellTitle = {
/** @type {'njs-cell-title'} */
Expand All @@ -22,6 +23,7 @@ const CellTitle = {
/**
* @interface
* @extends HTMLElement
* @since 2.0.0
*/
const CellSubTitle = {
/** @type {'njs-cell-sub-title'} */
Expand Down
242 changes: 123 additions & 119 deletions apis/stardust/api-spec/spec.json
View file
Expand Up @@ -344,6 +344,9 @@
"useEmbed": {
"description": "Gets the embed instance used.",
"stability": "experimental",
"availability": {
"since": "1.7.0"
},
"kind": "function",
"params": [],
"returns": {
Expand Down Expand Up @@ -642,7 +645,6 @@
},
"field": {
"description": "Gets the listbox instance of the specified field",
"stability": "experimental",
"availability": {
"since": "1.1.0"
},
Expand Down Expand Up @@ -692,7 +694,6 @@
}
},
"FieldInstance": {
"stability": "experimental",
"availability": {
"since": "1.1.0"
},
Expand All @@ -705,7 +706,6 @@
"staticEntries": {
"mount": {
"description": "Mounts the field as a listbox into the provided HTMLElement.",
"stability": "experimental",
"availability": {
"since": "1.1.0"
},
Expand Down Expand Up @@ -763,7 +763,6 @@
},
"unmount": {
"description": "Unmounts the field listbox from the DOM.",
"stability": "experimental",
"availability": {
"since": "1.1.0"
},
Expand Down Expand Up @@ -815,7 +814,6 @@
},
"convertTo": {
"description": "Converts the visualization to a different registered type",
"stability": "experimental",
"availability": {
"since": "1.1.0"
},
Expand Down Expand Up @@ -869,114 +867,6 @@
}
}
},
"Field": {
"kind": "alias",
"items": {
"kind": "union",
"items": [
{
"type": "string"
},
{
"type": "qae.NxDimension"
},
{
"type": "qae.NxMeasure"
},
{
"type": "#/definitions/LibraryField"
}
]
}
},
"CreateConfig": {
"description": "Rendering configuration for creating and rendering a new object",
"extends": [
{
"type": "#/definitions/BaseConfig"
}
],
"kind": "interface",
"entries": {
"type": {
"type": "string"
},
"version": {
"type": "string"
},
"fields": {
"optional": true,
"kind": "union",
"items": [
{
"kind": "array",
"items": {
"type": "#/definitions/Field"
}
}
]
},
"properties": {
"optional": true,
"type": "qae.GenericObjectProperties"
}
}
},
"BaseConfig": {
"description": "Basic rendering configuration for rendering an object",
"kind": "interface",
"entries": {
"element": {
"type": "HTMLElement"
},
"options": {
"optional": true,
"type": "object"
},
"plugins": {
"optional": true,
"kind": "array",
"items": {
"type": "#/definitions/Plugin"
}
}
}
},
"GetConfig": {
"description": "Rendering configuration for rendering an existing object",
"extends": [
{
"type": "#/definitions/BaseConfig"
}
],
"kind": "interface",
"entries": {
"id": {
"type": "string"
}
}
},
"LibraryField": {
"kind": "interface",
"entries": {
"qLibraryId": {
"type": "string"
},
"type": {
"kind": "union",
"items": [
{
"kind": "literal",
"value": "'dimension'"
},
{
"kind": "literal",
"value": "'measure'"
}
]
}
}
},
"AppSelections": {
"kind": "class",
"constructor": {
Expand Down Expand Up @@ -1170,6 +1060,114 @@
}
}
},
"Field": {
"kind": "alias",
"items": {
"kind": "union",
"items": [
{
"type": "string"
},
{
"type": "qae.NxDimension"
},
{
"type": "qae.NxMeasure"
},
{
"type": "#/definitions/LibraryField"
}
]
}
},
"CreateConfig": {
"description": "Rendering configuration for creating and rendering a new object",
"extends": [
{
"type": "#/definitions/BaseConfig"
}
],
"kind": "interface",
"entries": {
"type": {
"type": "string"
},
"version": {
"type": "string"
},
"fields": {
"optional": true,
"kind": "union",
"items": [
{
"kind": "array",
"items": {
"type": "#/definitions/Field"
}
}
]
},
"properties": {
"optional": true,
"type": "qae.GenericObjectProperties"
}
}
},
"BaseConfig": {
"description": "Basic rendering configuration for rendering an object",
"kind": "interface",
"entries": {
"element": {
"type": "HTMLElement"
},
"options": {
"optional": true,
"type": "object"
},
"plugins": {
"optional": true,
"kind": "array",
"items": {
"type": "#/definitions/Plugin"
}
}
}
},
"GetConfig": {
"description": "Rendering configuration for rendering an existing object",
"extends": [
{
"type": "#/definitions/BaseConfig"
}
],
"kind": "interface",
"entries": {
"id": {
"type": "string"
}
}
},
"LibraryField": {
"kind": "interface",
"entries": {
"qLibraryId": {
"type": "string"
},
"type": {
"kind": "union",
"items": [
{
"kind": "literal",
"value": "'dimension'"
},
{
"kind": "literal",
"value": "'measure'"
}
]
}
}
},
"Plugin": {
"description": "An object literal containing meta information about the plugin and a function containing the plugin implementation.",
"stability": "experimental",
Expand Down Expand Up @@ -1242,6 +1240,9 @@
}
},
"ActionElement": {
"availability": {
"since": "2.0.0"
},
"extends": [
{
"type": "HTMLElement"
Expand Down Expand Up @@ -1270,6 +1271,9 @@
}
},
"CellFooter": {
"availability": {
"since": "2.0.0"
},
"extends": [
{
"type": "HTMLElement"
Expand All @@ -1284,6 +1288,9 @@
}
},
"CellTitle": {
"availability": {
"since": "2.0.0"
},
"extends": [
{
"type": "HTMLElement"
Expand All @@ -1298,6 +1305,9 @@
}
},
"CellSubTitle": {
"availability": {
"since": "2.0.0"
},
"extends": [
{
"type": "HTMLElement"
Expand Down Expand Up @@ -1964,7 +1974,6 @@
},
"ExportFormat": {
"description": "Used for exporting and importing properties between backend models. An object that exports to\nExportFormat should put dimensions and measures inside one data group. If an object has two hypercubes,\neach of the cubes should export dimensions and measures in two separate data groups.\nAn object that imports from this structure is responsible for putting the existing properties where they should be\nin the new model.",
"stability": "experimental",
"availability": {
"since": "1.1.0"
},
Expand All @@ -1989,7 +1998,6 @@
}
},
"ExportDataDef": {
"stability": "experimental",
"availability": {
"since": "1.1.0"
},
Expand Down Expand Up @@ -2028,7 +2036,6 @@
}
},
"ConversionType": {
"stability": "experimental",
"availability": {
"since": "1.1.0"
},
Expand All @@ -2044,15 +2051,13 @@
},
"Conversion": {
"description": "Provides conversion functionality to extensions.",
"stability": "experimental",
"availability": {
"since": "1.1.0"
},
"kind": "interface",
"entries": {
"hypercube": {
"description": "Provides conversion functionality to extensions with hyperCubes.",
"stability": "experimental",
"availability": {
"since": "1.1.0"
},
Expand All @@ -2064,7 +2069,6 @@
]
},
"hyperCubeConversion": {
"stability": "experimental",
"availability": {
"since": "1.1.0"
},
Expand Down

0 comments on commit f182372

Please sign in to comment.