capabilities.json

{
  "dataRoles": [
    {
      "displayName": "Values (y axis)",
      "description": "Numeric values - the thing you are measuring.",
      "kind": "GroupingOrMeasure",
      "name": "value"
    },

    {
      "displayName": "Dates (x axis)",
      "description": "Dates (text column in format yyyy-mm-dd or dd-mm-yyyy, or PowerBI date column).",
      "kind": "GroupingOrMeasure",
      "name": "date"
    },

    {
      "displayName": "Identifier - e.g. KPI Name (OPTIONAL)",
      "description": "Optional for single graph or card. If a single value for the whole dataset, will be used as the graph/card title by default. Mandatory for summary tables and summary matrix.",
      "kind": "GroupingOrMeasure",
      "name": "what"
    },

    {
      "displayName": "Improvement Direction (increase or decrease)",
      "description": "Optional for single graph or card. Mandatory for summary tables and summary matrix.",
      "kind": "GroupingOrMeasure",
      "name": "improvement_direction"
    },

    {
      "displayName": "Target (OPTIONAL)",
      "description": "Optional for single graph or card - can be manually set in options. Optional for summary tables and summary matrix but cannot be manually set in options for these visual types.",
      "kind": "GroupingOrMeasure",
      "name": "target"
    },


    {
      "displayName": "Recalculation Points (OPTIONAL)",
      "description": "Optional for all visual types. A column containing y, Y, Yes or YES at every point that the process limits should be recalculated.",
      "kind": "GroupingOrMeasure",
      "name": "recalc_here"
    },

    {
      "displayName": "Is value a percentage? (OPTIONAL)",
      "description": "Optional for all visual types. Can be used to automatically determine whether a value is interpreted as a percentage.",
      "kind": "GroupingOrMeasure",
      "name": "is_percentage"
    },

    {
      "displayName": "Annotations (OPTIONAL)",
      "description": "Optional for all visual types. Will only be included in standard graph.",
      "kind": "GroupingOrMeasure",
      "name": "annotations"
    },

    {
      "displayName": "Baseline Duration (OPTIONAL)",
      "description": "Optional for all visual types. Can be used to override default baseline duration.",
      "kind": "GroupingOrMeasure",
      "name": "baseline_duration"
    }


  ],
  "dataViewMappings": [
    {
      "conditions": [
        {
          "value": {
            "max": 1
          },
          "date": {
            "max": 1
          },
          "what": {
            "max": 1
          },
          "improvement_direction": {
            "max": 1
          },
          "target": {
            "max": 1
          },
          "recalc_here": {
            "max": 1
          },
          "is_percentage": {
            "max": 1
          },
          "annotations": {
            "max": 1
          },
          "baseline_duration": {
            "max": 1
          }
        }




      ],
      "scriptResult": {
        "dataInput": {
          "table": {
            "rows": {
              "select": [
                {
                  "for": {
                    "in": "value"
                  }
                },
                {
                  "for": {
                    "in": "date"
                  }
                },
                {
                  "for": {
                    "in": "what"
                  }
                },
                {
                  "for": {
                    "in": "target"
                  }
                },
                {
                  "for": {
                    "in": "improvement_direction"
                  }
                },
                {
                  "for": {
                    "in": "recalc_here"
                  }
                },
                {
                  "for": {
                    "in": "is_percentage"
                  }
                },
                {
                  "for": {
                    "in": "annotations"
                  }
                },
                {
                  "for": {
                    "in": "baseline_duration"
                  }
                }
              ],
              "dataReductionAlgorithm": {
                "top": {}
              }
            }
          }
        },
        "script": {
          "scriptProviderDefault": "R",
          "scriptOutputType": "html",
          "source": {
            "objectName": "rcv_script",
            "propertyName": "source"
          },
          "provider": {
            "objectName": "rcv_script",
            "propertyName": "provider"
          }
        }
      }
    }
  ],
  "objects": {

    "outputtypesettings": {
      "displayName": "Output Type",
      "description": "Output Type",
      "properties": {
        "OutputType": {
          "displayName": "Select Output Type",
          "description": "Select whether to display a graph, card or summary table (coming soon)",
          "type": {
            "enumeration": [
              {
                "displayName": "Graph",
                "value": "graph"
              },
              {
                "displayName": "FacetedGraph",
                "value": "facet_graph"
              },
              {
                "displayName": "Card",
                "value": "card"
              },
              {
                "displayName": "Summary Table",
                "value": "summarytable"
              },
              {
                "displayName": "Summary Matrix",
                "value": "summarymatrix"
              }
            ]
          }
        }
    }
    },

    "spcsettings": {
      "displayName": "SPC Settings",
      "description": "SPC Settings",
      "properties": {
        "ValueIsPercentage": {
          "displayName": "Value is %?",
          "description": "If your percentage is stored as a decimal between 0 and 1, make it display more clearly.",
          "type": {
            "bool": true
          }
        },

        "ImprovementDirection": {
          "displayName": "Manually Set Improvement Direction (if improvement direction column not provided)",
          "description": "If improvement direction is not provided in the dataset, you can set it here.",
          "type": {
            "enumeration": [
              {
                "displayName": "Increase",
                "value": "increase"
              },
              {
                "displayName": "Decrease",
                "value": "decrease"
              },
              {
                "displayName": "Neutral (coming soon)",
                "value": "neutral"
              }
            ]
          }
        },

        "Target": {
          "displayName": "Manually Set Target (if target column not provided)",
          "description": "If a target is not provided in the dataset, you can set it here. This will only work for a single graph or card, not a summary matrix or table.",
          "type": {
            "numeric": true
          }
        },

        "Baseline": {
          "displayName": "Manually Set Baseline (if baseline column not provided)",
          "description": "If a baseline is not provided in the dataset, you can set it here. This will only work for a single graph or card, not a summary matrix or table.",
          "type": {
            "numeric": true
          }
        },
        
        "PadWithZeros": {
          "displayName": "(EXPERIMENTAL) Replace missing values with zeros?",
          "description": "If true, will attempt to work out sequence frequency and pad with zeros.",
          "type": {
            "bool": true
          }
        }
    }
    },


    "titlesettings": {
      
      "displayName": "Title Settings",
      "description": "Title and Title Size",
      "properties": {
        "TitleOn": {
          "displayName": "Display Title?",
          "description": "Turn title on or off",
          "type": {
            "bool": true
          }
        },

        "ChartTitle": {
          "displayName": "Chart Title",
          "description": "Set chart title",
          "type": {
            "text": true
          }
        },
        "TitleSize": {
          "displayName": "Title Font Size",
          "description": "Set size of font",
          "type": {
            "numeric": true
          }
        },

        "TitleJustification": {
          "displayName": "Title Justification",
          "description": "Set Title Justification",
          "type": {
            "enumeration": [
              {
                "displayName": "Central",
                "value": "central"
              },
              {
                "displayName": "Left",
                "value": "left"
              }
            ]
          }
        }

      }
    },

    "xaxissettings": {
      "displayName": "X Axis Settings",
      "description": "X Axis theme and title",
      "properties": {
        "XAxisTitle": {
          "displayName": "X Axis Title",
          "description": "Set X Axis Title",
          "type": {
            "text": true
          }
        }
    }
  },

  "yaxissettings": {
    "displayName": "Y Axis Settings",
    "description": "Y Axis theme and title",
    "properties": {

      "YAxisTitle": {
        "displayName": "Y Axis Title",
        "description": "Set Y Axis Title",
        "type": {
          "text": true
        }
      }
      
  }
},

"pointsettings": {
  "displayName": "Point Settings",
  "description": "Point size",
  "properties": {
    "PointSize": {
      "displayName": "Point Size",
      "description": "Set Point Size",
      "type": {
        "numeric": true
      }
    }
}
},

"legendsettings": {
  "displayName": "Legend Settings",
  "description": "Legend position",
  "properties": {
    "LegendPosition": {
      "displayName": "Legend position",
      "description": "Set legend position or turn legend off",
      "type": {
        "enumeration": [
          {
            "displayName": "Below",
            "value": "below"
          },
          {
            "displayName": "Right",
            "value": "right"
          },
          {
            "displayName": "Off",
            "value": "off"
          }
        ]
      }
    }
}
},

"iconsettings": {
  "displayName": "Icon Settings",
  "description": "Icon size",
  "properties": {
    "IconSize": {
      "displayName": "Icon Size",
      "description": "Set Icon Size",
      "type": {
        "numeric": true
      }
    }
}
},

"cardsettings": {
  "displayName": "Card Settings",
  "description": "Card theme and settings",
  "properties": {

    "CardPrefix": {
      "displayName": "Card Prefix",
      "description": "Value to appear before card value",
      "type": {
        "text": true
      }
    },

    "CardSuffix": {
      "displayName": "Card Suffix",
      "description": "Value to appear after card value",
      "type": {
        "text": true
      }
    },

    "ValueSize": {
      "displayName": "Value Size",
      "description": "Set Value Size",
      "type": {
        "numeric": true
      }
    },

    "IconPosition": {
      "displayName": "Icon Position",
      "description": "Set Value Size",
      "type": {
        "enumeration": [
          {
            "displayName": "Central",
            "value": "central"
          },
          {
            "displayName": "Right",
            "value": "right"
          }
        ]
      }
    },

    "CardTitleJustification": {
      "displayName": "Card Title Justification",
      "description": "Set Card Title Justification",
      "type": {
        "enumeration": [
          {
            "displayName": "Central",
            "value": "central"
          },
          {
            "displayName": "Left",
            "value": "left"
          }
        ]
      }
    }

}
},

"facetsettings": {
  "displayName": "Facet Settings",
  "description": "Facet graph output settings",
  "properties": {
    "NumRows": {
      "displayName": "Number of Rows",
      "description": "Set number of rows to split the faceted plot into",
      "type": {
        "numeric": true
      }
    },
    "FixedYAxisScale": {
      "displayName": "Fixed Y Axis Scale",
      "description": "Determine whether Y axis is fixed across facets or allowed to vary",
      "type": {
        "bool": true
      }
    }
}
},


"manualrebasesettings": {
  "displayName": "Manually Set Rebase Points",
  "description": "Pass a string of comma separated dates in the format yyyy-mm-dd to rebase (recalculate process limits) at those dates",
  "properties": {
    "ManualRebasePoints": {
      "displayName": "Rebase Points (e.g. 2013-01-31, 2015-04-30)",
      "description": "Pass a string of comma separated dates in the format yyyy-mm-dd to rebase (recalculate process limits) at those dates",
      "type": {
        "text": true
      }
    }
}
},


    "rcv_script": {
      "properties": {
        "provider": {
          "type": {
            "text": true
          }
        },
        "source": {
          "type": {
            "scripting": {
              "source": true
            }
          }
        }
      }
    }
  },
  "suppressDefaultTitle": true
}