capabilities.json

{
  "supportsHighlight": true,
  "sorting": {
    "implicit": {
      "clauses": [{
        "role": "key",
        "direction": 1
      }]
    }
  },
  "dataRoles": [
    {
      "displayName": "Outcome/Numerator",
      "name": "numerators",
      "kind": "Measure"
    },
    {
      "displayName": "Denominator",
      "name": "denominators",
      "kind": "Measure"
    },
    {
      "displayName": "ID Key (Date or ID for xbar/s)",
      "name": "key",
      "kind": "Grouping"
    },
    {
      "displayName": "SD (for xbar)",
      "name": "xbar_sds",
      "kind": "Measure"
    }
  ],
  "objects": {
    "split_indexes_storage" : {
      "displayName" : "Hidden",
      "properties": {
        "split_indexes": {
          "displayName": "Hidden",
          "type": { "text": true }
        }
      }
    },
    "spc" : {
      "displayName": "Data Settings",
      "properties": {
        "chart_type": {
          "displayName": "Chart Type",
          "type" : {
            "enumeration" : [
              {
                "displayName" : "run - Run Chart",
                "value" : "run"
              },
              {
                "displayName" : "i - Individual Measurements",
                "value" : "i"
              },
              {
                "displayName" : "mr - Moving Range of Individual Measurements",
                "value" : "mr"
              },
              {
                "displayName" : "p - Proportions",
                "value" : "p"
              },
              {
                "displayName" : "p prime - Proportions Chart with Large Sample Correction",
                "value" : "pp"
              },
              {
                "displayName" : "u - Rates",
                "value" : "u"
              },
              {
                "displayName" : "u prime - Rates Chart with Large Sample Correction",
                "value" : "up"
              },
              {
                "displayName" : "c - Counts",
                "value" : "c"
              },
              {
                "displayName" : "xbar - Sample Means",
                "value" : "xbar"
              },
              {
                "displayName" : "s - Sample SDs",
                "value" : "s"
              },
              {
                "displayName" : "g - Number of Non-Events Between Events",
                "value" : "g"
              },
              {
                "displayName" : "t - Time Between Events",
                "value" : "t"
              }
            ]
          }
        },
        "outliers_in_limits": {
          "displayName": "Keep Outliers in Limit Calcs.",
          "type": { "bool": true }
        },
        "multiplier": {
          "displayName": "Multiplier",
          "type": { "numeric": true }
        },
        "sig_figs": {
          "displayName": "Decimals to Report:",
          "type": { "numeric": true }
        },
        "perc_labels": {
          "displayName": "Report as percentage",
          "type": {
            "enumeration" : [
              {
                "displayName" : "Automatic",
                "value" : "Automatic"
              },
              {
                "displayName" : "Yes",
                "value" : "Yes"
              },
              {
                "displayName" : "No",
                "value" : "No"
              }
            ]
          }
        },
        "split_on_click": {
          "displayName": "Split Limits on Click",
          "type" : { "bool" : true }
        },
        "ll_truncate": {
          "displayName": "Truncate Lower Limits at:",
          "type": { "numeric": true }
        },
        "ul_truncate": {
          "displayName": "Truncate Upper Limits at:",
          "type": { "numeric": true }
        },
        "alt_target": {
          "displayName": "Additional Target Value:",
          "type": { "numeric": true }
        }
      }
    },
    "outliers" : {
      "displayName": "Outlier Highlighting",
      "properties": {
        "process_flag_type": {
          "displayName": "Type of Change to Flag",
          "type": {
            "enumeration" : [
              {
                "displayName" : "Both",
                "value" : "both"
              },
              {
                "displayName" : "Improvement (Imp.)",
                "value" : "improvement"
              },
              {
                "displayName" : "Deterioration (Det.)",
                "value" : "deterioration"
              }
            ]
          }
        },
        "improvement_direction": {
          "displayName": "Improvement Direction",
          "type": {
            "enumeration" : [
              {
                "displayName" : "Increase",
                "value" : "increase"
              },
              {
                "displayName" : "Neutral",
                "value" : "neutral"
              },
              {
                "displayName" : "Decrease",
                "value" : "decrease"
              }
            ]
          }
        },
        "astronomical": {
          "displayName": "Astronomical Points",
          "type" : { "bool" : true }
        },
        "ast_colour_improvement":{
          "displayName": "Imp. Ast. Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "ast_colour_deterioration":{
          "displayName": "Det. Ast. Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "ast_colour_neutral_low":{
          "displayName": "Neutral (Low) Ast. Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "ast_colour_neutral_high":{
          "displayName": "Neutral (High) Ast. Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "shift": {
          "displayName": "Shifts",
          "type" : { "bool" : true }
        },
        "shift_n": {
          "displayName": "Shift Points",
          "type" : { "numeric": true }
        },
        "shift_colour_improvement":{
          "displayName": "Imp. Shift Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "shift_colour_deterioration":{
          "displayName": "Det. Shift Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "shift_colour_neutral_low":{
          "displayName": "Neutral (Low) Shift Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "shift_colour_neutral_high":{
          "displayName": "Neutral (High) Shift Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "trend": {
          "displayName": "Trends",
          "type" : { "bool" : true }
        },
        "trend_n": {
          "displayName": "Trend Points",
          "type" : { "numeric": true }
        },
        "trend_colour_improvement":{
          "displayName": "Imp. Trend Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "trend_colour_deterioration":{
          "displayName": "Det. Trend Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "trend_colour_neutral_low":{
          "displayName": "Neutral (Low) Trend Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "trend_colour_neutral_high":{
          "displayName": "Neutral (High) Trend Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "two_in_three": {
          "displayName": "Two-in-Three",
          "type" : { "bool" : true }
        },
        "twointhree_colour_improvement":{
          "displayName": "Imp. Two-in-Three Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "twointhree_colour_deterioration":{
          "displayName": "Det. Two-in-Three Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "twointhree_colour_neutral_low":{
          "displayName": "Neutral (Low) Two-in-Three Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "twointhree_colour_neutral_high":{
          "displayName": "Neutral (High) Two-in-Three Colour",
          "type": { "fill": { "solid": { "color": true } } }
        }
      }
    },
    "nhs_icons" : {
      "displayName": "NHS Icons",
      "properties": {
        "show_variation_icons": {
          "displayName": "Show Variation Icons",
          "type" : { "bool" : true }
        },
        "flag_variation_last": {
          "displayName": "Flag Only Last Point",
          "type" : { "bool" : true }
        },
        "variation_icons_locations": {
          "displayName": "Variation Icon Locations",
          "type": {
            "enumeration" : [
              {
                "displayName" : "Top Right",
                "value" : "Top Right"
              },
              {
                "displayName" : "Bottom Right",
                "value" : "Bottom Right"
              },
              {
                "displayName" : "Top Left",
                "value" : "Top Left"
              },
              {
                "displayName" : "Bottom Left",
                "value" : "Bottom Left"
              }
            ]
          }
        },
        "variation_icons_scaling":{
          "displayName": "Scale Variation Icon Size",
          "type": { "numeric": true }
        }
      }
    },
    "canvas": {
      "displayName": "Canvas Settings",
      "properties": {
        "lower_padding":{
          "displayName": "Padding Below Plot (pixels):",
          "type": { "numeric": true }
        },
        "upper_padding":{
          "displayName": "Padding Above Plot (pixels):",
          "type": { "numeric": true }
        },
        "left_padding":{
          "displayName": "Padding Left of Plot (pixels):",
          "type": { "numeric": true }
        },
        "right_padding":{
          "displayName": "Padding Right of Plot (pixels):",
          "type": { "numeric": true }
        }
      }
    },
    "scatter": {
      "displayName": "Scatter Settings",
      "properties": {
        "size": {
          "displayName": "Dot Size",
          "type": { "numeric": true }
        },
        "opacity": {
          "displayName": "Opacity",
          "type": { "numeric": true }
        },
        "opacity_unselected": {
          "displayName": "Opacity if Unselected",
          "type": { "numeric": true }
        },
        "colour":{
          "displayName": "Colour",
          "type": { "fill": { "solid": { "color": true } } }
        }
      }
    },
    "dates": {
      "displayName": "Date Format",
      "properties": {
        "date_format_locale": {
          "displayName": "Locale",
          "type": {
            "enumeration" : [
              {
                "displayName" : "en-GB",
                "value" : "en-GB"
              },
              {
                "displayName" : "en-US",
                "value" : "en-US"
              }
            ]
          }
        },
        "date_format_day": {
          "displayName": "Day Format",
          "type": {
            "enumeration" : [
              {
                "displayName" : "DD",
                "value" : "DD"
              },
              {
                "displayName" : "Thurs DD",
                "value" : "Thurs DD"
              },
              {
                "displayName" : "Thursday DD",
                "value" : "Thursday DD"
              }
            ]
          }
        },
        "date_format_month": {
          "displayName": "Month Format",
          "type": {
            "enumeration" : [
              {
                "displayName" : "MM",
                "value" : "MM"
              },
              {
                "displayName" : "Mon",
                "value" : "Mon"
              },
              {
                "displayName" : "Month",
                "value" : "Month"
              }
            ]
          }
        },
        "date_format_year": {
          "displayName": "Year Format",
          "type": {
            "enumeration" : [
              {
                "displayName" : "YYYY",
                "value" : "YYYY"
              },
              {
                "displayName" : "YY",
                "value" : "YY"
              }
            ]
          }
        },
        "date_format_delim": {
          "displayName": "Delimiter",
          "type": {
            "enumeration" : [
              {
                "displayName" : "/",
                "value" : "/"
              },
              {
                "displayName" : "-",
                "value" : "-"
              },
              {
                "displayName" : " ",
                "value" : " "
              }
            ]
          }
        }
      }
    },
    "lines": {
      "displayName": "Line Settings",
      "properties": {
        "width_99": {
          "displayName": "99.8% Line Width",
          "type": { "numeric": true }
        },
        "width_95": {
          "displayName": "95% Line Width",
          "type": { "numeric": true }
        },
        "width_main": {
          "displayName": "Main Line Width",
          "type": { "numeric": true }
        },
        "width_target": {
          "displayName": "Target Line Width",
          "type": { "numeric": true }
        },
        "width_alt_target": {
          "displayName": "Alt. Target Line Width",
          "type": { "numeric": true }
        },
        "type_99": {
          "displayName": "99.8% Line Type",
          "type": {
            "enumeration" : [
              {
                "displayName" : "Solid",
                "value" : "10 0"
              },
              {
                "displayName" : "Dashed",
                "value" : "10 10"
              },
              {
                "displayName" : "Dotted",
                "value" : "2 5"
              }
            ]
          }
        },
        "type_95": {
          "displayName": "95% Line Type",
          "type": {
            "enumeration" : [
              {
                "displayName" : "Solid",
                "value" : "10 0"
              },
              {
                "displayName" : "Dashed",
                "value" : "10 10"
              },
              {
                "displayName" : "Dotted",
                "value" : "2 5"
              }
            ]
          }
        },
        "type_main": {
          "displayName": "Main Line Type",
          "type": {
            "enumeration" : [
              {
                "displayName" : "Solid",
                "value" : "10 0"
              },
              {
                "displayName" : "Dashed",
                "value" : "10 10"
              },
              {
                "displayName" : "Dotted",
                "value" : "2 5"
              }
            ]
          }
        },
        "type_target": {
          "displayName": "Target Line Type",
          "type": {
            "enumeration" : [
              {
                "displayName" : "Solid",
                "value" : "10 0"
              },
              {
                "displayName" : "Dashed",
                "value" : "10 10"
              },
              {
                "displayName" : "Dotted",
                "value" : "2 5"
              }
            ]
          }
        },
        "type_alt_target": {
          "displayName": "Alt. Target Line Type",
          "type": {
            "enumeration" : [
              {
                "displayName" : "Solid",
                "value" : "10 0"
              },
              {
                "displayName" : "Dashed",
                "value" : "10 10"
              },
              {
                "displayName" : "Dotted",
                "value" : "2 5"
              }
            ]
          }
        },
        "colour_99":{
          "displayName": "99.8% Line Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "colour_95":{
          "displayName": "95% Line Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "colour_main":{
          "displayName": "Main Line Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "colour_target":{
          "displayName": "Target Line Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "colour_alt_target":{
          "displayName": "Alt. Target Line Colour",
          "type": { "fill": { "solid": { "color": true } } }
        }
      }
    },
    "x_axis": {
      "displayName": "X-Axis Settings",
      "properties": {
        "xlimit_colour":{
          "displayName": "Axis Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "xlimit_ticks": {
          "displayName": "Draw Ticks",
          "type" : { "bool" : true }
        },
        "xlimit_tick_font": {
          "displayName": "Tick Font",
          "type": { "formatting": { "fontFamily": true } }
        },
        "xlimit_tick_size": {
          "displayName": "Tick Font Size",
          "type": { "formatting": { "fontSize": true } }
        },
        "xlimit_tick_colour":{
          "displayName": "Tick Font Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "xlimit_tick_rotation": {
          "displayName": "Tick Rotation (Degrees)",
          "type": { "numeric": true }
        },
        "xlimit_tick_count": {
          "displayName": "Maximum Ticks",
          "type": { "numeric": true }
        },
        "xlimit_label": {
          "displayName": "Label",
          "type": { "text": true }
        },
        "xlimit_label_font": {
          "displayName": "Label Font",
          "type": { "formatting": { "fontFamily": true } }
        },
        "xlimit_label_size": {
          "displayName": "Label Font Size",
          "type": { "formatting": { "fontSize": true } }
        },
        "xlimit_label_colour":{
          "displayName": "Label Font Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "xlimit_l": {
          "displayName": "Lower Limit",
          "type": { "numeric": true }
        },
        "xlimit_u": {
          "displayName": "Upper Limit",
          "type": { "numeric": true }
        }
      }
    },
    "y_axis": {
      "displayName": "Y-Axis Settings",
      "properties": {
        "ylimit_colour":{
          "displayName": "Axis Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "ylimit_ticks": {
          "displayName": "Draw Ticks",
          "type" : { "bool" : true }
        },
        "ylimit_sig_figs": {
            "displayName": "Tick Decimal Places",
            "type": { "numeric": true }
        },
        "ylimit_tick_font": {
          "displayName": "Tick Font",
          "type": { "formatting": { "fontFamily": true } }
        },
        "ylimit_tick_size": {
          "displayName": "Tick Font Size",
          "type": { "formatting": { "fontSize": true } }
        },
        "ylimit_tick_colour":{
          "displayName": "Tick Font Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "ylimit_tick_rotation": {
          "displayName": "Tick Rotation (Degrees)",
          "type": { "numeric": true }
        },
        "ylimit_tick_count": {
          "displayName": "Maximum Ticks",
          "type": { "numeric": true }
        },
        "ylimit_label": {
          "displayName": "Label",
          "type": { "text": true }
        },
        "ylimit_label_font": {
          "displayName": "Label Font",
          "type": { "formatting": { "fontFamily": true } }
        },
        "ylimit_label_size": {
          "displayName": "Label Font Size",
          "type": { "formatting": { "fontSize": true } }
        },
        "ylimit_label_colour":{
          "displayName": "Label Font Colour",
          "type": { "fill": { "solid": { "color": true } } }
        },
        "limit_multiplier": {
          "displayName": "Axis Scaling Factor",
          "type": { "numeric": true }
        },
        "ylimit_l": {
          "displayName": "Lower Limit",
          "type": { "numeric": true }
        },
        "ylimit_u": {
          "displayName": "Upper Limit",
          "type": { "numeric": true }
        }
      }
    }
  },
  "dataViewMappings": [{
    "conditions": [{
      "key": { "max": 5 },
      "numerators": { "max": 1 },
      "denominators": { "max": 1 },
      "xbar_sds": { "max": 1 }
    }],
    "categorical": {
      "categories": {
        "for": { "in": "key" },
        "dataReductionAlgorithm": { "window": { "count": 30000 } }
      },
      "values": {
        "select": [
          { "bind": { "to": "numerators" } },
          { "bind": { "to": "denominators" } },
          { "bind": { "to": "xbar_sds" } }
        ]
      }
    }
  }]
}