jprdonnelly/nebula.js
1
0
Fork 0
mirror of https://github.com/qlik-oss/nebula.js.git synced 2025-12-19 17:58:43 -05:00
Code Issues Projects Releases Wiki Activity

fix: ignore api spec and checkin with scriptappy format (#757)

Browse Source
This commit is contained in:
Christian Veinfors
2022-02-10 14:02:24 +01:00
committed by GitHub
parent 9bce736e88
commit 80c7f899ed
2 changed files with 38 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.prettierignore
View File

@@ -1,2 +1,3 @@
dist/
**/index.d.ts
**/spec.json

50
apis/stardust/api-spec/spec.json
View File

@@ -25,7 +25,9 @@
"returns": {
"type": "#/definitions/Embed"
},
"examples": ["import { embed } from '@nebula.js/stardust'\nconst n = embed(app);\nn.render({ id: 'abc' });"],
"examples": [
"import { embed } from '@nebula.js/stardust'\nconst n = embed(app);\nn.render({ id: 'abc' });"
],
"entries": {
"createConfiguration": {
"description": "Creates a new `embed` scope bound to the specified `configuration`.\n\nThe configuration is merged with all previous scopes.",
@@ -353,7 +355,9 @@
"description": "The embed instance used.",
"type": "#/definitions/Embed"
},
"examples": ["import { useEmbed } from '@nebula.js/stardust';\n\nconst embed = useEmbed();\nembed.render(...)"]
"examples": [
"import { useEmbed } from '@nebula.js/stardust';\n\nconst embed = useEmbed();\nembed.render(...)"
]
},
"useTranslator": {
"description": "Gets the translator.",
@@ -670,7 +674,9 @@
}
]
},
"examples": ["const selections = await n.selections();\nselections.mount(element);"]
"examples": [
"const selections = await n.selections();\nselections.mount(element);"
]
},
"field": {
"description": "Gets the listbox instance of the specified field",
@@ -822,7 +828,9 @@
}
}
],
"examples": ["fieldInstance.mount(element);"]
"examples": [
"fieldInstance.mount(element);"
]
},
"unmount": {
"description": "Unmounts the field listbox from the DOM.",
@@ -831,7 +839,9 @@
},
"kind": "function",
"params": [],
"examples": ["listbox.unmount();"]
"examples": [
"listbox.unmount();"
]
}
}
},
@@ -879,7 +889,9 @@
"description": "Destroys the visualization and removes it from the the DOM.",
"kind": "function",
"params": [],
"examples": ["const viz = await embed(app).render({\n element,\n id: 'abc'\n});\nviz.destroy();"]
"examples": [
"const viz = await embed(app).render({\n element,\n id: 'abc'\n});\nviz.destroy();"
]
},
"convertTo": {
"description": "Converts the visualization to a different registered type",
@@ -914,7 +926,9 @@
]
}
},
"examples": ["const viz = await embed(app).render({\n element,\n type: 'barchart'\n});\nviz.destroy();"]
"examples": [
"const viz = await embed(app).render({\n element,\n type: 'barchart'\n});\nviz.destroy();"
]
},
"Flags": {
"kind": "interface",
@@ -952,13 +966,17 @@
"type": "HTMLElement"
}
],
"examples": ["selections.mount(element);"]
"examples": [
"selections.mount(element);"
]
},
"unmount": {
"description": "Unmounts the app selection UI from the DOM.",
"kind": "function",
"params": [],
"examples": ["selections.unmount();"]
"examples": [
"selections.unmount();"
]
}
}
},
@@ -2022,7 +2040,9 @@
"description": "The resolved color.",
"type": "string"
},
"examples": ["theme.getColorPickerColor({ index: 1 });\ntheme.getColorPickerColor({ color: 'red' });"]
"examples": [
"theme.getColorPickerColor({ index: 1 });\ntheme.getColorPickerColor({ color: 'red' });"
]
},
"getContrastingColorTo": {
"description": "Get the best contrasting color against the specified `color`.\nThis is typically used to find a suitable text color for a label placed on an arbitrarily colored background.\n\nThe returned colors are derived from the theme.",
@@ -2038,7 +2058,9 @@
"description": "- The color that has the best contrast against the specified `color`.",
"type": "string"
},
"examples": ["theme.getContrastingColorTo('#400');"]
"examples": [
"theme.getContrastingColorTo('#400');"
]
},
"getStyle": {
"description": "Get the value of a style attribute in the theme by searching in the theme's JSON structure.\nThe search starts at the specified base path and continues upwards until the value is found.\nIf possible it will get the attribute's value using the given path.",
@@ -2064,7 +2086,9 @@
"description": "The style value",
"type": "string"
},
"examples": ["theme.getStyle('object', 'title.main', 'fontSize');\ntheme.getStyle('', '', 'fontSize');"]
"examples": [
"theme.getStyle('object', 'title.main', 'fontSize');\ntheme.getStyle('', '', 'fontSize');"
]
}
},
"definitions": {
@@ -2289,4 +2313,4 @@
"entries": {}
}
}
}
}