@furo/ui5
Version:
SAP UI5 Web Components data bindings for furo-web
984 lines (980 loc) • 875 kB
JSON
{
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
"name": "@furo/ui5",
"version": "1.18.1",
"description-markup": "markdown",
"js-types-syntax": "typescript",
"default-icon": "icon.svg",
"contributions": {
"html": {
"elements": [
{
"name": "furo-ui5-barcode-scanner-dialog",
"source": {
"module": "./src/furo-ui5-barcode-scanner-dialog.js",
"symbol": "FuroUi5BarcodeScannerDialog"
},
"deprecated": false,
"experimental": false,
"description": "The 'furo-ui5-barcode-scanner-dialog' component provides barcode scanning functionality for all devices that\nsupport the MediaDevices.getUserMedia() native API. Opening the dialog launches the device camera and scans for known barcode formats.\nInternally, the component uses the zxing-js/library third party OSS. For a list of supported barcode formats, see the\nzxing-js/library documentation. https://github.com/zxing-js/library\n\nIt supports all features from the [SAP ui5 Barcode Scanner Dialog element](https://sap.github.io/ui5-webcomponents/playground/components/BarcodeScannerDialog/).\n\nYou can bind any `string` type, like `furo.fat.String` type or the `google.protobuf.StringValue` type.\n\n```html\n <furo-ui5-button at-click=--openClicked>Open Scanner</furo-ui5-button>\n <furo-ui5-barcode-scanner-dialog fn-show=\"--openClicked\"\n fn-bind-data=\"--dao(*.field)\"></furo-ui5-barcode-scanner-dialog>\n\n```\n\n## Methods\n**bindData(fieldNode)**\nBind an entity field. You can use the entity even when no data was received.\n\nWhen you use at-object-ready from a furo-data-object which emits a EntityNode, just bind the field with --entity(*.fields.fieldname)",
"doc-url": "https://ui5.furo.pro/docs/components/furo-ui5-barcode-scanner-dialog/",
"attributes": [
]
,
"js": {
"properties": [
],
"methods": [],
"events": [
{
"name": "scan-success",
"priority": "highest",
"description": " Fires when the scan is completed successfuuly.",
"value": {
"type": "String"
}
}
,
{
"name": "scan-error",
"priority": "highest",
"description": " Fires when the scan fails with error.",
"value": {
"type": "String"
}
}
,
{
"name": "furo-value-changed",
"priority": "highest",
"description": "Fires the field value when it changes.",
"value": {
"type": "String"
}
} ]
}
},
{
"name": "furo-ui5-bool-icon",
"source": {
"module": "./src/furo-ui5-bool-icon.js",
"symbol": "FuroDataBoolIcon"
},
"deprecated": false,
"experimental": false,
"description": "Displays a icon/symbol for a boolean value\n\nThis component uses the SAP Ui5 icons.\nhttps://openui5.hana.ondemand.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html\n\n```html\n<furo-ui5-bool-icon fn-bind-data=\"--dao(FIELDNODE)\"></furo-ui5-bool-icon>\n```\n\nOnly `@ui5/webcomponents-icons/dist/navigation-down-arrow.js` and `@ui5/webcomponents-icons/dist/navigation-right-arrow.js` are imported.\nIf you set other icons, please do not forget to import them.",
"doc-url": "https://ui5.furo.pro/docs/components/furo-ui5-bool-icon/",
"attributes": [{
"name": "symboltrue",
"type": "string",
"priority": "highest",
"description": "Defines the icon for the true state.",
"default": "'navigation-down-arrow'"
}, {
"name": "symbolfalse",
"type": "string",
"priority": "highest",
"description": "Defines the icon for the false state.",
"default": "'navigation-right-arrow'"
}
]
,
"js": {
"properties": [{
"name": "symboltrue",
"type": "string",
"priority": "high",
"description": "Defines the icon for the true state.",
"default": "'navigation-down-arrow'"
}, {
"name": "symbolfalse",
"type": "string",
"priority": "high",
"description": "Defines the icon for the false state.",
"default": "'navigation-right-arrow'"
}, {
"name": "field",
"type": "object",
"priority": "high",
"description": "",
"default": "{}"
}
],
"methods": [
{
"name": "-fbp-ready",
"description": "flow is ready lifecycle method",
"value": {
"type": "string",
"required": true
}
}
, {
"name": "bind-data",
"description": "Binds a FieldNode\n\nSupported types: `bool`",
"value": {
"type": "string",
"required": true
}
}
, {
"name": "toggle",
"description": "Toggles the icon.",
"value": {
"type": "string",
"required": true
}
}]
}
},
{
"name": "furo-ui5-busy-indicator",
"source": {
"module": "./src/furo-ui5-busy-indicator.js",
"symbol": "FuroUiBusyIndicator"
},
"deprecated": false,
"experimental": false,
"description": "The furo-ui5-busy-indicator signals that some operation is going on and that the user must wait.\n\n```html\n<furo-ui5-busy-indicator></furo-ui5-busy-indicator>\n```\n\nhttps://sap.github.io/ui5-webcomponents/playground/components/BusyIndicator/",
"doc-url": "https://ui5.furo.pro/docs/components/furo-ui5-busy-indicator/",
"attributes": [
]
,
"js": {
"properties": [
],
"methods": [
{
"name": "activate",
"description": "Sets the busy indicator state to active",
"value": {
"type": "string",
"required": true
}
}
, {
"name": "deactivate",
"description": "Sets the busy indicator state to inactive",
"value": {
"type": "string",
"required": true
}
}]
}
},
{
"name": "furo-ui5-button",
"source": {
"module": "./src/furo-ui5-button.js",
"symbol": "FuroUi5Button"
},
"deprecated": false,
"experimental": false,
"description": "The furo-ui5-button component represents a simple push button. It enables users to trigger actions by clicking or\ntapping the furo-ui5-button, or by pressing certain keyboard keys, such as Enter.\nUsage\nFor the furo-ui5-button UI, you can define text, icon, or both. You can also specify whether the text or the icon is displayed first.\n\n```html\n<furo-ui5-button>Register</furo-ui5-button>\n```\n\nYou can choose from a set of predefined types that offer different styling to correspond to the triggered action.\n\nYou can set the furo-ui5-button as enabled or disabled.\nAn enabled ui5-button can be pressed by clicking or tapping it.\nThe button changes its style to provide visual feedback to the user that it is pressed or hovered over with the mouse cursor.\nA disabled furo-ui5-button appears inactive and cannot be pressed.\n\nWhat is different from ui5-button?\nWith flow based programming it's usual to address functions. So we added two convenience functions for\n- disabling => fn-disable\n- enabling => fn-enable\n\nhttps://sap.github.io/ui5-webcomponents/playground/components/Button/",
"doc-url": "https://ui5.furo.pro/docs/components/furo-ui5-button/",
"attributes": [
]
,
"js": {
"properties": [
],
"methods": [
{
"name": "disable",
"description": "Sets the button state to disabled",
"value": {
"type": "string",
"required": true
}
}
, {
"name": "enable",
"description": "Sets the button state to enabled",
"value": {
"type": "string",
"required": true
}
}
, {
"name": "show",
"description": "shows the button, when it was hidden before",
"value": {
"type": "string",
"required": true
}
}
, {
"name": "hide",
"description": "hides the button",
"value": {
"type": "string",
"required": true
}
}]
}
},
{
"name": "furo-ui5-card",
"source": {
"module": "./src/furo-ui5-card.js",
"symbol": "FuroUi5Card"
},
"deprecated": false,
"experimental": false,
"description": "The furo-ui5-card is a bindable card that represents information in the form of a tile with\nseparate header and content areas.\n\n```html\n <furo-ui5-card\n heading=\"Title\"\n subheading=\"Secondary text\"\n icon=\"card\"\n >\n <div slot=\"action\"><furo-ui5-button>Action</furo-ui5-button></div>\n <div slot=\"content\">content goes here</div>\n </furo-ui5-card>\n```\n\n## How To Use Semantic Colors\nYou can use semantic colors to visualize the status or state. Set the attribute design=\"\" with the following values:\n- Positive (--sapPositiveColor)\n- Negative (--sapNegativeColor)\n- Critical (--sapCriticalColor)\n- Neutral (--sapCriticalColor)\n\n```html\n <furo-ui5-card\n design=\"Positive\"\n icon=\"card\"\n >\n <div slot=\"content\">content goes here</div>\n </furo-ui5-card>\n```",
"doc-url": "https://ui5.furo.pro/docs/components/furo-ui5-card/",
"attributes": [{
"name": "heading",
"type": "string",
"priority": "highest",
"description": "Defines the title displayed in the ui5-card header.",
"default": "''"
}, {
"name": "subheading",
"type": "string",
"priority": "highest",
"description": "Defines the subheading displayed in the ui5-card header.",
"default": "''"
}, {
"name": "icon",
"type": "string",
"priority": "highest",
"description": "Defines the visual representation in the header of the card. Supports images and icons.\nhttps://openui5.hana.ondemand.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html",
"default": "''"
}, {
"name": "status",
"type": "string",
"priority": "highest",
"description": "Defines the status text displayed in the card header (upper right).\n\nBy enabling the status, actions are not visible.",
"default": "''"
}, {
"name": "header-interactive",
"type": "boolean",
"priority": "highest",
"description": "Defines if the ui5-card header would be interactive, e.g gets hover effect, gets focused and header-click event is fired, when it is pressed.",
"default": "false"
}, {
"name": "no-content-padding",
"type": "boolean",
"priority": "highest",
"description": "Shows the content slot area with no padding",
"default": "false"
}
],
"slots": [
{
"name": "action",
"description": "defines an action, displayed in the right most part of the header. Note: If status is set, the status text will be displayed, you can either have action, or status."
}
, {
"name": "content",
"description": "defines the content of the card"
} ]
,
"js": {
"properties": [{
"name": "icon",
"type": "string",
"priority": "high",
"description": "Defines the visual representation in the header of the card. Supports images and icons.\nhttps://openui5.hana.ondemand.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html",
"default": "''"
}, {
"name": "heading",
"type": "string",
"priority": "high",
"description": "Defines the title displayed in the ui5-card header.",
"default": "''"
}, {
"name": "subheading",
"type": "string",
"priority": "high",
"description": "Defines the subheading displayed in the ui5-card header.",
"default": "''"
}, {
"name": "status",
"type": "string",
"priority": "high",
"description": "Defines the status text displayed in the card header (upper right).\n\nBy enabling the status, actions are not visible.",
"default": "''"
}, {
"name": "headerInteractive",
"type": "boolean",
"priority": "high",
"description": "Defines if the ui5-card header would be interactive, e.g gets hover effect, gets focused and header-click event is fired, when it is pressed.",
"default": "false"
}, {
"name": "noContentPadding",
"type": "boolean",
"priority": "high",
"description": "Shows the content slot area with no padding",
"default": "false"
}
],
"methods": [
{
"name": "bind-heading",
"description": "Binds any **scalar** field to set the title of the panel.\n\nSupported types: scalar types e.g. `string`",
"value": {
"type": "string",
"required": true
}
}
, {
"name": "bind-icon",
"description": "Binds a FieldNode to set the icon of the panel.\n\nDo not forget to import the icon you will use in your component.\n\nSupported types: `string`",
"value": {
"type": "string",
"required": true
}
}
, {
"name": "bind-subheading",
"description": "Binds any **scalar** field to set the subtitle of the panel.\n\nSupported types: scalar types e.g. `string`",
"value": {
"type": "string",
"required": true
}
}
, {
"name": "bind-nav-node",
"description": "Binds a FieldNode with the following signature:\n\n- display_name (`string`)\n- secondary_text (`string`)\n- icon (`string`)",
"value": {
"type": "string",
"required": true
}
}],
"events": [
{
"name": "header-clicked",
"priority": "highest",
"description": "Fired when the card head is clicked. The header-interactive attribute must be set.",
"value": {
"type": ""
}
}
,
{
"name": "header-click",
"priority": "highest",
"description": "Fired when interactive header was clicked.",
"value": {
"type": ""
}
} ]
}
},
{
"name": "furo-ui5-chart-display",
"source": {
"module": "./src/furo-ui5-chart-display.js",
"symbol": "FuroUi5ChartDisplay"
},
"deprecated": false,
"experimental": false,
"description": "The furo-ui5-chart-display is the render component\nto display charts with apex the apex charts lib (https://github.com/apexcharts/apexcharts.js).\n\n Use `furo-ui5-chart` to connect your data.\n\n ```html\n <furo-ui5-chart-display chart-type=\"bar\">\n <furo-ui5-chart\n fn-bind-data=\"--projectDAO(*.entities)\"\n data-field=\"data.cost_limit.units\"\n category-field=\"data.description\"\n ></furo-ui5-chart>\n </furo-ui5-chart-display>\n ```",
"doc-url": "https://ui5.furo.pro/docs/components/furo-ui5-chart-display/",
"attributes": [{
"name": "chart-type",
"type": "String",
"priority": "highest",
"description": "\nline, area, bar are mixable\n\nradar, scatter, heatmap\n\npie donut polarArea radialBar can only consume 1 data series"
}, {
"name": "title-text",
"type": "String",
"priority": "highest",
"description": "Set the title."
}, {
"name": "title-align",
"type": "String",
"priority": "highest",
"description": "Aligns the title. Possible values are 'left', 'center', 'right'\n\nDefault is **left**"
}, {
"name": "title-offset-x",
"type": "Number",
"priority": "highest",
"description": "Moves the title for n pixels on the x-axis from the alignment direction"
}, {
"name": "title-offset-y",
"type": "Number",
"priority": "highest",
"description": "Moves the title for n pixels on the y-axis from the alignment direction"
}, {
"name": "no-data-text",
"type": "String",
"priority": "highest",
"description": "Set the text to display, if no data is given.\n\nIf this option is not set, the default is **No data.**"
}, {
"name": "stacked",
"type": "Boolean",
"priority": "highest",
"description": "WORK IN PROGRESS\nStacked bar charts are not mixable"
}, {
"name": "data-labels",
"type": "Boolean",
"priority": "highest",
"description": "Enable labels with data on every item."
}, {
"name": "fixed-height",
"type": "Number",
"priority": "highest",
"description": "Set a fixed height for the plot. Default is auto, this can be useful if you need to control the heights"
}, {
"name": "tooltip",
"type": "Boolean",
"priority": "highest",
"description": "show a tooltip on mouseover"
}, {
"name": "legend",
"type": "Boolean",
"priority": "highest",
"description": "Enables the legend on bottom left with offset 0:0"
}, {
"name": "grid",
"type": "Boolean",
"priority": "highest",
"description": "Draw the horizontal grid lines"
}, {
"name": "legend-align",
"type": "String",
"priority": "highest",
"description": "Aligns the legend to `left` `center` `right`\n\ndefault is **left**"
}, {
"name": "legend-position",
"type": "String",
"priority": "highest",
"description": "Set the position of the legend to `top`, `right`, `bottom`, `left`\n\nDefault is **bottom**"
}, {
"name": "legend-offset-x",
"type": "Number",
"priority": "highest",
"description": "Moves the legend in the **x** direction for n pixels from `legend-position`"
}, {
"name": "legend-offset-y",
"type": "Number",
"priority": "highest",
"description": "Moves the legend in the **y** direction for n pixels from `legend-position`"
}, {
"name": "toolbar",
"type": "Boolean",
"priority": "highest",
"description": "Enables the toolbar"
}, {
"name": "toolbar-download",
"type": "Boolean",
"priority": "highest",
"description": "Enables the download option in the toolbar (svg,csv,png)"
}, {
"name": "plot-horizontal",
"type": "boolean",
"priority": "highest",
"description": "Enable this to draw the bars horizontally"
}, {
"name": "sparkline",
"type": "Boolean",
"priority": "highest",
"description": "Hides all elements of the chart other than the primary graphic.\nUse this to visualize data in very small areas."
}, {
"name": "zebra",
"type": "String",
"priority": "highest",
"description": "set zebra color like zebra=\"#f3f4f5, #fff\" to get stripes"
}, {
"name": "xaxis-title",
"type": "String",
"priority": "highest",
"description": "Give the x-axis a title which will be displayed below the axis labels by default."
}, {
"name": "xaxis-datetime",
"type": "Boolean",
"priority": "highest",
"description": "Set this to true if you have datetime, google.type.date or timestamp data on the x-axis"
}
]
,
"js": {
"properties": [{
"name": "sparkline",
"type": "Boolean",
"priority": "high",
"description": "Hides all elements of the chart other than the primary graphic.\nUse this to visualize data in very small areas."
}, {
"name": "xaxisTitle",
"type": "String",
"priority": "high",
"description": "Give the x-axis a title which will be displayed below the axis labels by default."
}, {
"name": "xaxisDatetime",
"type": "Boolean",
"priority": "high",
"description": "Set this to true if you have datetime, google.type.date or timestamp data on the x-axis"
}, {
"name": "zebra",
"type": "String",
"priority": "high",
"description": "set zebra color like zebra=\"#f3f4f5, #fff\" to get stripes"
}, {
"name": "noDataText",
"type": "String",
"priority": "high",
"description": "Set the text to display, if no data is given.\n\nIf this option is not set, the default is **No data.**"
}, {
"name": "legend",
"type": "Boolean",
"priority": "high",
"description": "Enables the legend on bottom left with offset 0:0"
}, {
"name": "dataLabels",
"type": "Boolean",
"priority": "high",
"description": "Enable labels with data on every item."
}, {
"name": "tooltip",
"type": "Boolean",
"priority": "high",
"description": "show a tooltip on mouseover"
}, {
"name": "legendAlign",
"type": "String",
"priority": "high",
"description": "Aligns the legend to `left` `center` `right`\n\ndefault is **left**"
}, {
"name": "legendPosition",
"type": "String",
"priority": "high",
"description": "Set the position of the legend to `top`, `right`, `bottom`, `left`\n\nDefault is **bottom**"
}, {
"name": "legendOffsetX",
"type": "Number",
"priority": "high",
"description": "Moves the legend in the **x** direction for n pixels from `legend-position`"
}, {
"name": "legendOffsetY",
"type": "Number",
"priority": "high",
"description": "Moves the legend in the **y** direction for n pixels from `legend-position`"
}, {
"name": "toolbar",
"type": "Boolean",
"priority": "high",
"description": "Enables the toolbar"
}, {
"name": "toolbarDownload",
"type": "Boolean",
"priority": "high",
"description": "Enables the download option in the toolbar (svg,csv,png)"
}, {
"name": "plotHorizontal",
"type": "boolean",
"priority": "high",
"description": "Enable this to draw the bars horizontally"
}, {
"name": "grid",
"type": "Boolean",
"priority": "high",
"description": "Draw the horizontal grid lines"
}, {
"name": "chartType",
"type": "String",
"priority": "high",
"description": "\nline, area, bar are mixable\n\nradar, scatter, heatmap\n\npie donut polarArea radialBar can only consume 1 data series"
}, {
"name": "stacked",
"type": "Boolean",
"priority": "high",
"description": "WORK IN PROGRESS\nStacked bar charts are not mixable"
}, {
"name": "titleText",
"type": "String",
"priority": "high",
"description": "Set the title."
}, {
"name": "titleAlign",
"type": "String",
"priority": "high",
"description": "Aligns the title. Possible values are 'left', 'center', 'right'\n\nDefault is **left**"
}, {
"name": "titleOffsetX",
"type": "Number",
"priority": "high",
"description": "Moves the title for n pixels on the x-axis from the alignment direction"
}, {
"name": "titleOffsetY",
"type": "Number",
"priority": "high",
"description": "Moves the title for n pixels on the y-axis from the alignment direction"
}, {
"name": "fixedHeight",
"type": "Number",
"priority": "high",
"description": "Set a fixed height for the plot. Default is auto, this can be useful if you need to control the heights"
}, {
"name": "apexOptions",
"type": "object",
"priority": "high",
"description": "",
"default": "{\n series: [],\n yaxis: [],\n // belize qualitative color palette\n // node_modules/@ui5/webcomponents-theming/dist/themes/sap_fiori_3/css_variables.css\n colors: [\n 'var(--sapChart_OrderedColor_1 , #5899da)',\n 'var(--sapChart_OrderedColor_2 , #e8743b)',\n 'var(--sapChart_OrderedColor_3 , #19a979)',\n 'var(--sapChart_OrderedColor_4 , #ed4a7b)',\n 'var(--sapChart_OrderedColor_5 , #945ecf)',\n 'var(--sapChart_OrderedColor_6 , #13a4b4)',\n 'var(--sapChart_OrderedColor_7 , #525df4)',\n 'var(--sapChart_OrderedColor_8 , #bf399e)',\n 'var(--sapChart_OrderedColor_9 , #6c8893)',\n 'var(--sapChart_OrderedColor_10 ,: #ee6868)',\n 'var(--sapChart_OrderedColor_11 ,: #2f6497)',\n ],\n noData: {\n text: 'No data.',\n align: 'center',\n verticalAlign: 'middle',\n offsetX: 0,\n offsetY: 0,\n style: {\n color: undefined,\n fontSize: '14px',\n fontFamily: undefined,\n },\n },\n chart: {\n // height: 550,\n fontFamily: 'var(--sapFontFamily, Helvetica, Arial, sans-serif)',\n foreColor: 'var(--sapTextColor)',\n type: 'line',\n stacked: false,\n background: 'unset',\n events: {},\n toolbar: {\n show: false, // disable by default\n tools: {\n download: false,\n selection: true,\n zoom: true,\n zoomin: true,\n zoomout: true,\n pan: true,\n reset: true,\n },\n },\n sparkline: {\n enabled: false,\n },\n },\n grid: {\n show: false, // https://apexcharts.com/docs/options/grid/\n // zebra\n // row: {\n // colors: [\"#f3f4f5\", \"#fff\"],\n // }\n },\n dataLabels: {\n enabled: false,\n },\n\n title: {\n // text: 'XYZ - Analysis',\n align: 'left',\n // offsetX: 70,\n },\n stroke: {},\n\n tooltip: {\n enabled: false,\n fixed: {\n enabled: false,\n position: 'topLeft', // topRight, topLeft, bottomRight, bottomLeft\n offsetY: 30,\n offsetX: 160,\n },\n },\n legend: {\n show: false,\n position: 'bottom',\n horizontalAlign: 'left',\n offsetX: 0,\n offsetY: 0,\n formatter: (seriesName, opts) => {\n if (\n opts.w.config.yaxis[opts.seriesIndex] &&\n opts.w.config.yaxis[opts.seriesIndex].legendLabel\n ) {\n return [opts.w.config.yaxis[opts.seriesIndex].legendLabel];\n }\n return [seriesName];\n },\n },\n plotOptions: {},\n xaxis: {\n // type: \"datetime\",\n\n // tickAmount: 6,\n title: {\n text: undefined,\n },\n },\n }"
}
],
"methods": [],
"events": [
{
"name": "data-point-clicked",
"priority": "highest",
"description": " Fired when a marker for this data source was clicked. Note: the event is fired from the furo-ui5-chart",
"value": {
"type": "Fieldnode"
}
} ]
}
},
{
"name": "furo-ui5-chart",
"source": {
"module": "./src/furo-ui5-chart.js",
"symbol": "FuroUi5Chart"
},
"deprecated": false,
"experimental": false,
"description": "furo-ui5-chart connects data objects (repeaterNodes) with the charting lib.\n\n Use multiple binders if you need more then one series per chart.\n\n ```html\n <furo-ui5-chart-display chart-type=\"bar\">\n <furo-ui5-chart\n fn-bind-data=\"--projectDAO(*.entities)\"\n data-field=\"data.cost_limit.units\"\n category-field=\"data.description\"\n ></furo-ui5-chart>\n </furo-ui5-chart-display>\n ```",
"doc-url": "https://ui5.furo.pro/docs/components/furo-ui5-chart/",
"attributes": [{
"name": "data-field",
"type": "String",
"priority": "highest",
"description": "Define the data field or fields here. For most charts this is **the y axis**.\n\nSome charts requires more then one data field (i.e. bubbles want at least 3 fields `data-field=\"data.start.day, data.end.day, data.start.day\"` )."
}, {
"name": "category-field",
"type": "String",
"priority": "highest",
"description": "Define the category field here (only 1 field). You can think of this as it is the x axis for your chart."
}, {
"name": "legend-label",
"type": "String",
"priority": "highest",
"description": "Label the Series for the legend. This text is also shown on the tooltips. This is useful when you have more then one data series."
}, {
"name": "series-name",
"type": "String",
"priority": "highest",
"description": "Series with same name will get the same y-axis"
}, {
"name": "chart-type",
"type": "String",
"priority": "highest",
"description": "**Use this for mixed charts scenarios only**, prefer to define the chart-type on the chart-display.\nSpecify the default type on the display and set the custom type on this binder."
}, {
"name": "chart-color",
"type": "String",
"priority": "highest",
"description": "If you need to give an explicit color for the series you can use this attribute."
}, {
"name": "axis-label-opposite",
"type": "Boolean",
"priority": "highest",
"description": "Put the axis label on the opposite site (usually right)"
}, {
"name": "axis-label",
"type": "String",
"priority": "highest",
"description": "Text for the y axis"
}, {
"name": "axis-label-color",
"type": "String",
"priority": "highest",
"description": "Custom color for the y axis description text"
}, {
"name": "axis-border",
"type": "Boolean",
"priority": "highest",
"description": "Show a border on the right side of the y axis descriptions and labels."
}, {
"name": "axis-border-color",
"type": "String",
"priority": "highest",
"description": "Custom color for the border."
}, {
"name": "axis-ticks",
"type": "Boolean",
"priority": "highest",
"description": "Show tick marks on the y axis."
}, {
"name": "axis-tooltip",
"type": "Boolean",
"priority": "highest",
"description": "Show a tooltip with the current value while hovering."
}, {
"name": "axis-ticks-color",
"type": "String",
"priority": "highest",
"description": "Custom color for the ticks"
}, {
"name": "chart-curve",
"type": "string",
"priority": "highest",
"description": "Define the curve style for line and area charts.\n\n Possible values: `smooth`, `straight`, `stepline`",
"default": "'straight'"
}, {
"name": "chart-stroke-width",
"type": "number",
"priority": "highest",
"description": "Define the thickness of the lines in px.",
"default": "1"
}, {
"name": "chart-marker-size",
"type": "number",
"priority": "highest",
"description": "Set the size of the markers (hover state) in px.",
"default": "0"
}, {
"name": "xaxis",
"type": "String",
"priority": "highest",
"description": ""
}
]
,
"js": {
"properties": [{
"name": "axisLabelOpposite",
"type": "Boolean",
"priority": "high",
"description": "Put the axis label on the opposite site (usually right)"
}, {
"name": "axisLabel",
"type": "String",
"priority": "high",
"description": "Text for the y axis"
}, {
"name": "axisLabelColor",
"type": "String",
"priority": "high",
"description": "Custom color for the y axis description text"
}, {
"name": "axisBorder",
"type": "Boolean",
"priority": "high",
"description": "Show a border on the right side of the y axis descriptions and labels."
}, {
"name": "axisBorderColor",
"type": "String",
"priority": "high",
"description": "Custom color for the border."
}, {
"name": "axisTicks",
"type": "Boolean",
"priority": "high",
"description": "Show tick marks on the y axis."
}, {
"name": "axisTooltip",
"type": "Boolean",
"priority": "high",
"description": "Show a tooltip with the current value while hovering."
}, {
"name": "axisTicksColor",
"type": "String",
"priority": "high",
"description": "Custom color for the ticks"
}, {
"name": "seriesName",
"type": "String",
"priority": "high",
"description": "Series with same name will get the same y-axis"
}, {
"name": "legendLabel",
"type": "String",
"priority": "high",
"description": "Label the Series for the legend. This text is also shown on the tooltips. This is useful when you have more then one data series."
}, {
"name": "strokeWidth",
"type": "number",
"priority": "high",
"description": "Define the thickness of the lines in px.",
"default": "1"
}, {
"name": "markerSize",
"type": "number",
"priority": "high",
"description": "Set the size of the markers (hover state) in px.",
"default": "0"
}, {
"name": "strokeCurve",
"type": "string",
"priority": "high",
"description": "Define the curve style for line and area charts.\n\n Possible values: `smooth`, `straight`, `stepline`",
"default": "'straight'"
}, {
"name": "dataField",
"type": "String",
"priority": "high",
"description": "Define the data field or fields here. For most charts this is **the y axis**.\n\nSome charts requires more then one data field (i.e. bubbles want at least 3 fields `data-field=\"data.start.day, data.end.day, data.start.day\"` )."
}, {
"name": "categoryField",
"type": "String",
"priority": "high",
"description": "Define the category field here (only 1 field). You can think of this as it is the x axis for your chart."
}, {
"name": "chartType",
"type": "String",
"priority": "high",
"description": "**Use this for mixed charts scenarios only**, prefer to define the chart-type on the chart-display.\nSpecify the default type on the display and set the custom type on this binder."
}, {
"name": "chartColor",
"type": "String",
"priority": "high",
"description": "If you need to give an explicit color for the series you can use this attribute."
}, {
"name": "xaxis",
"type": "String",
"priority": "high",
"description": ""
}
],
"methods": [
{
"name": "bind-data",
"description": "Binds a RepeaterNode to the component.\n\nSupported types: repeated types",
"value": {
"type": "string",
"required": true
}
}],
"events": [
{
"name": "data-point-clicked",
"priority": "highest",
"description": " Fired when a marker for this data source was clicked",
"value": {
"type": "Fieldnode"
}
}
,
{
"name": "data-updated",
"priority": "highest",
"description": " Fired when datasource has updated data",
"value": {
"type": "data-series"
}
} ]
}
},
{
"name": "furo-ui5-checkbox-input-labeled",
"source": {
"module": "./src/furo-ui5-checkbox-input-labeled.js",
"symbol": "FuroUi5CheckboxInputLabeled"
},
"deprecated": false,
"experimental": false,
"description": "The furo-ui5-checkbox-input-labeled is a composition to easily use a complete input field with label according\nto the design specification of SAP Fiori Design System.\n\n```html\n<furo-ui5-checkbox-input-labeled fn-bind-data=\"--dao(FIELDNODE)\"></furo-ui5-checkbox-labeled>\n```",
"doc-url": "https://ui5.furo.pro/docs/components/furo-ui5-checkbox-input-labeled/",
"attributes": [{
"name": "label",
"type": "string",
"priority": "highest",
"description": "the label for the data-checkbox-input",
"default": "''"
}, {
"name": "full",
"type": "boolean",
"priority": "highest",
"description": "This is only used to forward the state to the form-field-container"
}, {
"name": "placeholder",
"type": "String",
"priority": "highest",
"description": "the placeholder is the additional information beside the label. it will be showed on the right side of the checkbox."
}, {
"name": "required",
"type": "Boolean",
"priority": "highest",
"description": "A Boolean attribute which, if present, means this field is required and marked with *."
}, {
"name": "disabled",
"type": "Boolean",
"priority": "highest",
"description": "A Boolean attribute which, if present, means this field cannot be edited by the user."
}, {
"name": "readonly",
"type": "Boolean",
"priority": "highest",
"description": "A Boolean attribute which, if present, means this field is readonly."
}
]
,
"js": {
"properties": [{
"name": "label",
"type": "string",
"priority": "high",
"description": "the label for the data-checkbox-input",
"default": "''"
}, {
"name": "full",
"type": "boolean",
"priority": "high",
"description": "This is only used to forward the state to the form-field-container"
}, {
"name": "placeholder",
"type": "String",
"priority": "high",
"description": "the placeholder is the additional information beside the label. it will be showed on the right side of the checkbox."
}, {
"name": "required",
"type": "Boolean",
"priority": "high",
"description": "A Boolean attribute which, if present, means this field is required and marked with *."
}, {
"name": "disabled",
"type": "Boolean",
"priority": "high",
"description": "A Boolean attribute which, if present, means this field cannot be edited by the user."
}, {
"name": "readonly",
"type": "Boolean",
"priority": "high",
"description": "A Boolean attribute which, if present, means this field is readonly."
}
],
"methods": [
{
"name": "focus",
"description": "Focuses the underlying ui5 input element",
"value": {
"type": "string",
"required": true
}
}
, {
"name": "bind-data",
"description": "Binds a FieldNode to the component.\n\nSupported types: `bool`, `google.protobuf.BoolValue`, `furo.fat.Bool`",
"value": {
"type": "string",
"required": true
}
}]
}
},
{
"name": "furo-ui5-checkbox-input",
"source": {
"module": "./src/furo-ui5-checkbox-input.js",
"symbol": "FuroUi5CheckboxInput"
},
"deprecated": false,
"experimental": false,
"description": "The 'furo-ui5-checkbox-input' component allows the user to switch true and false for type Bool with data binding.\n\nIt supports all features from the [SAP ui5 checkbox element](https://sap.github.io/ui5-webcomponents/playground/components/CheckBox/).\n\nBindable FieldNodes: `bool` type, `furo.fat.Bool` type or the `google.wrapper.BoolValue` type.\n\n```html\n <furo-ui5-checkbox-input\n fn-bind-data=\"--dao(FIELDNODE)\"\n ></furo-ui5-checkbox-input>\n```\n\n### Specificity\n1. Attributes which are set in the html source will have the highest specificity and will never get overwritten by metas or fat.\n2. Attributes set in meta will have the lowest specificity and will be overwritten by attributes from fat.\n\n| meta | fat | html |\n|------ |----- |------ |\n| 1 | 10 | 100 |\n\n\n## supported FAT attributes\n - **\"readonly\":\"true\"** set the element to readonly\n - **\"disabled\":\"true\"** set the element to disabled\n\n## supported meta and constraints\n- **readonly: true** , set the element to readonly\n\nThe constraint **required** will mark the element as required.",
"doc-url": "https://ui5.furo.pro/docs/components/furo-ui5-checkbox-input/",
"attributes": [
]
,
"js": {
"properties": [
],
"methods": [
{
"name": "check",
"description": "Checks the checkbox and updates the value",
"value": {
"type": "string",
"require