analytics/perspectives/dashboard/contrib/BAkpi.json

{
	"copyright": "Licensed Materials - Property of IBM. IBM Cognos Products: BI Cloud(C) Copyright IBM Corp. 2019. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.",
	"features": [{
		"id": "com.ibm.bi.dashboard",
		"collectionItems": [{
			"containerId": "com.ibm.bi.dashboard.live-visualizations",
			"type": "KPI",
			"id": "kpi",
			"label": "%kpiCaption",
			"caption": "%kpiCaption",
			"icon": "visualizations-kpi",
			"placeholderIcon": "dashboard-analytics/images/placeholders/kpisummary.svg",
			"renderer": "dashboard-analytics\/visualizations\/renderer\/kpi\/KpiView",
			"scope": "default",
			"control": "dashboard-analytics\/visualizations\/renderer\/kpi\/control\/KpiControl",
			"supportsFormatAction": true,
			"supportsAdvancedProperties": false,
			"supportsCustomGroupAction": false,
			"supportsSortAction": true,
			"supportsFilterAction": true,
			"archetypes": ["kpi"],
			"preferredSize": {
				"width": 300,
				"height": 170
			},
			"propertyPrefixes": {
			},
			"propertyList": [
				{
				"id": "elementColor",
				"type":"colorClass",
				"editor": {
					"sectionId": "visualization.color",
					"position": 1,
					"uiControl": {
						"type": "ColorPicker",
						"label": "%prop_elementColor",
						"addButton": true,
						"showHexValue": true,
						"open": false,
						"ariaLabel": "%prop_elementColor",
						"paletteType": "DashboardColorSet",
						"missingIsLast": true
					}
				}
			}, {
				"id": "textAlignment",
				"defaultValue": "center",
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"type": "IconPicker",
						"label": "%prop_textAlignmentLabel",
						"items": [{
							"name": "left",
							"label": "%prop_textAlignmentLeftLabel",
							"value": "common-left-align"
						}, {
							"name": "center",
							"label": "%prop_textAlignmentCenterLabel",
							"value": "common-center-align"
						}, {
							"name": "right",
							"label": "%prop_textAlignmentRightLabel",
							"value": "common-right-align"
						}]
					}
				}
			}, {
				"id": "baseValueProperties",
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"label": "%prop_baseValuePropertiesLabel",
						"type": "SectionLabel"
					}
				}
			}, {
				"id": "baseValueSize",
				"defaultValue": "auto",
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"preRenderCallback": {
							"feature" : "Dashboard.KpiPropertyCallbacks",
							"callbackFunction": "preRenderValueSizeProperty",
							"callbackParams": []
						},
						"onChange": {
							"feature" : "Dashboard.KpiPropertyCallbacks",
							"callbackFunction": "onChangeValueSizeProperty",
							"callbackParams": []
						},
						"type": "DropDown",
						"label": "%prop_baseValueSize",
						"ariaDescribedby": "%prop_baseValueSizeDescription",
						"options": [{
							"label": "auto",
							"value": "auto"
						}, {
							"label": "24",
							"value": "24"
						}, {
							"label": "32",
							"value": "32"
						}, {
							"label": "48",
							"value": "48"
						}, {
							"label": "64",
							"value": "64"
						}]

					}
				}
			}, {
				"id": "showItemLabel",
				"defaultValue": true,
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"label": "%prop_showBaseLabelLabel",
						"type": "ToggleButton",
						"ariaLabel": "%prop_showBaseLabelDescription"

					}
				}
			}, {
				"id": "baseValueLabel",
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"preRenderCallback": {
							"feature" : "Dashboard.KpiPropertyCallbacks",
							"callbackFunction": "preRenderBaseLabelProperty",
							"callbackParams": []
						},
						"type": "InputLabel",
						"name": "baseValueLabel",
						"ellipses": false,
						"multilingual": true,
						"label": "%prop_baseLabelText",
						"ariaLabel": "%prop_baseLabelTextDescription",
						"newLook": true,
						"handleReturnKey": true
					}
				}
			}, {
				"id": "targetValueProperties",
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"label": "%prop_targetValuePropertiesLabel",
						"type": "SectionLabel"
					}
				}
			}, {
				"id": "targetValue",
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"preRenderCallback": {
							"feature" : "Dashboard.KpiPropertyCallbacks",
							"callbackFunction": "preRenderTargetValueProperty",
							"callbackParams": []
						},
						"customValidatorCallback": {
							"feature" : "Dashboard.KpiPropertyCallbacks",
							"callbackFunction": "validateTargetValueProperty",
							"callbackParams": []
						},
						"type": "InputLabel",
						"name": "targetValue",
						"ellipses": false,
						"showInlineError": true,
						"label": "%prop_targetValueText",
						"ariaLabel": "%prop_targetValueTextDescription",
						"placeHolderText": "%prop_targetValueTextPlaceholder",
						"newLook": true,
						"handleReturnKey": true
					}
				}
			}, {
				"id": "showTargetValue",
				"defaultValue": true,
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"type": "ToggleButton",
						"label": "%prop_showTargetValueLabel",
						"ariaLabel": "%prop_showTargetValueDescription"
					}
				}
			}, {
				"id": "showTargetDistance",
				"defaultValue": true,
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"type": "ToggleButton",
						"label": "%prop_showTargetDistanceLabel",
						"ariaLabel": "%prop_showTargetDistanceDescription"
					}
				}
			}, {
				"id": "targetValueSize",
				"defaultValue": "auto",
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"preRenderCallback": {
							"feature" : "Dashboard.KpiPropertyCallbacks",
							"callbackFunction": "preRenderValueSizeProperty",
							"callbackParams": []
						},
						"onChange": {
							"feature" : "Dashboard.KpiPropertyCallbacks",
							"callbackFunction": "onChangeValueSizeProperty",
							"callbackParams": []
						},
						"type": "DropDown",
						"label": "%prop_targetValueSize",
						"ariaDescribedby": "%prop_targetValueSizeDescription",
						"options": [{
							"label": "auto",
							"value": "auto"
						}, {
							"label": "14",
							"value": "14"
						}, {
							"label": "16",
							"value": "16"
						}, {
							"label": "24",
							"value": "24"
						}, {
							"label": "32",
							"value": "32"
						}]
					}
				}
			}, {
				"id": "showTargetLabel",
				"defaultValue": true,
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"type": "ToggleButton",
						"label": "%prop_showTargetLabelLabel",
						"ariaLabel": "%prop_showTargetLabelDescription"
					}
				}
			}, {
				"id": "targetValueLabel",
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"preRenderCallback": {
							"feature" : "Dashboard.KpiPropertyCallbacks",
							"callbackFunction": "preRenderTargetLabelProperty",
							"callbackParams": []
						},
						"type": "InputLabel",
						"name": "targetValueLabel",
						"ellipses": false,
						"multilingual": true,
						"label": "%prop_targetLabelText",
						"ariaLabel": "%prop_targetLabelTextDescription",
						"newLook": true,
						"handleReturnKey": true
					}
				}
			}, {
				"id": "timeProperties",
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"label": "%prop_timePropertiesLabel",
						"type": "SectionLabel"
					}
				}
			}, {
				"id": "showSparkline",
				"defaultValue": true,
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"type": "ToggleButton",
						"label": "%prop_showSparkline",
						"ariaLabel": "%prop_showSparklineDescription"

					}
				}
			}, {
				"id": "kpiPropertySpacer1",
				"editor": {
					"sectionId": "visualization.chart",
					"uiControl": {
						"type": "SectionLabel",
						"label": ""
					}
				}
			}],
			"propertyLayoutList": [{
				"type": "Group",
				"id": "visualization",
				"label": "%tabName_visualization"
			}, {
				"type": "Section",
				"id": "color",
				"label": "%sectionName_colorPalette",
				"position": 1
			}, {
				"type": "Section",
				"id": "chart",
				"label": "%sectionName_chart",
				"position": 4
			}],
			"datasets": [{
					"name": "data"
				}, {
					"name": "sparkline"
				}
			],
			"defaultDatasetId" : "data",
			"thumbnailConfig": {
				"unsupportedBrowsers": ["IE"]
			},
			"dataSlots": [{
				"id": "actual",
				"type": "ordinal",
				"caption": "%kpiSlotBaseValue",
				"multiItems" : false,
				"maxItems": 1,
				"datasetIdList": ["data"],
				"role": "response",
				"sortable": false,
				"mldTitleProperty": "baseValueLabel",
				"format": {
 					"type": "number",
					"maximumFractionDigits": 2,
					"decimalFormatLength": "short"
				}
			}, {
				"id": "goal",
				"type": "ordinal",
				"icon": "target",
				"caption": "%kpiSlotTargetValue",
				"multiItems" : false,
				"optional": true,
				"maxItems": 1,
				"datasetIdList": ["data"],
				"role": "response",
				"sortable": false,
				"mldTitleProperty": "targetValueLabel",
				"mldIndicatorIfUnmapped": true,
				"format": {
 					"type": "number",
					"maximumFractionDigits": 2,
					"decimalFormatLength": "short"
				}
			}, {
				"id": "sparkline.time",
				"type": "category",
				"icon": "time",
				"caption": "%kpiSlotTimeValue",
				"multiItems": true,
				"maxItems": 10,
				"optional": false,
				"showRequiredMarker": false,
				"datasetIdList": ["sparkline"],
				"role": "response",
				"sort": "asc",
				"sortOrder": 1,
				"multiplier": false,
				"stackItems": true
			}, {
				"id": "sparkline.actual",
				"type": "ordinal",
				"hidden": true,
				"caption": "%kpiSlotBaseValue",
				"multiItems": false,
				"maxItems": 1,
				"datasetIdList": ["sparkline"],
				"defaultFromSlot": {
 					"id": "actual"
				},
				"role": "response",
				"sortable": false
			}],
			"isRecommendable": true,
			"usages": ["Other"]
		}]
	}]
}