@nebula.js/sn-bar-chart
Version:
Bar chart supernova
105 lines (104 loc) • 3.5 kB
JSON
{
"scriptappy": "1.1.0",
"info": {
"name": "@nebula.js/sn-bar-chart:plugins",
"description": "Bar chart plugins API definitions",
"version": "1.39.1",
"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": {
"COLLECTION": {
"description": "The data collections the users can use to get data from",
"entries": {
"MAIN": {
"description": "The main data collection",
"type": "string"
}
},
"kind": "object"
},
"COMPONENT": {
"description": "The unique keys of the existing components available in the chart.\nThey are useful if you want to extend or override the existing components.",
"entries": {
"BAR": {
"description": "The bar component",
"type": "string"
},
"BAR_AXIS": {
"description": "The bar axis component",
"type": "string"
},
"DIMENSION_TITLE": {
"description": "The dimension title component",
"defaultValue": "dimension-title",
"type": "string"
},
"MEASURE_TITLE": {
"description": "The measure title component",
"defaultValue": "measure-title",
"type": "string"
},
"Y_AXIS": {
"description": "The y axis component",
"defaultValue": "y-axis",
"type": "string"
}
},
"kind": "object"
},
"SCALE": {
"description": "The scales associated with the bar 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": {
"MAIN": {
"description": "The main scales",
"entries": {
"MAJOR": {
"description": "The main major scale",
"type": "string"
},
"MINOR": {
"description": "The main minor scale",
"type": "string"
}
},
"kind": "object"
}
},
"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"
}
}
}
}