@nebula.js/sn-funnel-chart
Version:
A sequential chart visualizing a linear process with connected stages, for example a sales process with potential revenue at each stage.
78 lines (77 loc) • 2.61 kB
JSON
{
"scriptappy": "1.1.0",
"info": {
"name": "@nebula.js/sn-funnel-chart:plugins",
"description": "Funnel chart plugins API definitions",
"version": "1.9.34",
"license": "MIT",
"stability": "experimental",
"x-qlik-visibility": "public"
},
"entries": {
"pluginArguments": {
"description": "The arguments that are passed to the fn function of the plugin definition.",
"kind": "namespace",
"entries": {
"keys": {
"description": "The keys (references) to different types of chart internals",
"entries": {
"COMPONENT": {
"description": "The unique keys of the existing components available in the funnel chart.\nThey are useful if you want to extend or override the existing components.",
"entries": {
"DIMENSION_TITLE": {
"description": "The dimension title component",
"defaultValue": "dimension-title",
"type": "string"
},
"FUNNEL": {
"description": "The funnel component",
"defaultValue": "fun",
"type": "string"
},
"FUNNEL_LABELS": {
"description": "The funnel labels component",
"defaultValue": "funnel-labels",
"type": "string"
}
},
"kind": "object"
},
"SCALE": {
"description": "The scales associated with the funnel chart.\nThey are useful if you want to, via plugin, add a new component that\nuses the same scale as one of the measures.",
"entries": {
"FILL": {
"description": "The scale used for coloring the funnel segments",
"defaultValue": "fill",
"type": "string"
}
},
"kind": "object"
}
},
"kind": "object"
},
"layout": {
"description": "The layout from the enigma model.",
"type": "object"
}
}
}
},
"definitions": {
"getPluginArgs": {
"description": "Prepare important chart internals for the users to build their own plugins",
"kind": "function",
"params": [
{
"name": "layoutService",
"type": "object"
}
],
"returns": {
"description": "Chart internals that will be exposed to the users.",
"type": "#/entries/pluginArguments"
}
}
}
}