/
GRAPH FORMAT (JSON)

GRAPH FORMAT (JSON)

Owned by Pedro Jose Sanchez Luling
Last updated: Mar 09, 2022

Some graph related API functions accept a formatting expression to define the style of the graph.

If any property in the GRAPH FORMAT JSON is not specified, then a default value will be assigned. Therefore, it is not necessary to inform all the properties, but only those where the default value must be changed.

The filter is expressed in JSON format, and the possible properties are:

  • title: set of properties to print a general title for the graph
  • graph: general properties of the graph
  • yAxis: properties to determine the value range for the ordinate axis. If omitted then the value range is calculated automatically
  • xAxis: properties to determine the behavior of the abscise axis:
    • groupBy: (minute/hour/day/week/month) permits to group multiple points in a selected schema. For example, if the data source provides information for each day and "interval" is set to "month", then only one point will be drawn for that month. This property works together with "groupFunction" (which is specified in the "seriesFormat" block), which allows to decide how multiple points are grouped
    • fillGaps: determines if intermediate abscise points with no data must be displayed or not.
    • ticks: number of abscise ticks drawn in the abscise axis. If not specified, then all values will be printed (note that 'ticks' is not a interval, it is the absolute number of ticks drawn in the abscise axis)
    • dateFormat: Determines the format of the labels in the abscise axis
  • legend: determines whether a legend block must be displayed or not, and its format.
  • seriesFormat: array formatting option sets. Each formatting option set defines how the data serie will be represented in the graph. Note that it is possible to define more than one formatting options set for the same data serie. This will result in generating more than one graph for that serie (see the example below)
    • name: name of the data serie format (usually a DATACODE)
    • graphType: (bar/line/stackbar/scatter)
    • groupFunction: (max, min, avg, sum, median) is a function that determine the math function applied to multiple points that overlap in the same abscise point
    • lineWidth: (only for line graphs) thickness of the line
    • dotSize: (only for line graphs) interval of successive points drawn for the line. If the value is greater than 1, a discontinued line will be displayed (with greater segments as "dotSize" grows)
    • showValues: ("true"/"false") If true, then a label will be printed next to each point of the graph indicating the ordinate value
    • decimals: (only if "showValues"="true") Number of decimals that will be displayed for each value

Example

SUBSCRIPTION FILTER
{ "title" : {
    "text" : "",
    "font" : "tahoma",
    "size" : "24",
    "color" : "#0000ff",
    "xPos" : 300,
    "yPos" : 20
  },
  "graph" : {
    "width" : 630,
    "height" : 600,
    "areaXPos" : 40,
    "areaYPos" : 20,
    "areaWidth" : 600,
    "areaHeight" : 500,
    "grid" : "true"
  },
  "yAxis" : {
    "min" : 0,  // calculated automatically by default
    "max": 60  // calculated automatically by default
  },
  "xAxis" : {
    "font" : "tahoma",
    "size" : "12",
    "groupBy" : "day",      // Indicates which temporal interval represents each abscise coordinate (minute / hour /day / week / month)
    "fillGaps" : "false",   // Indicates whether to fill gaps between consecutive samples if they are separated by more than a "groupBy" unit
    "ticks" : "10",         // Options: "all"/"all_not_null"/n  n = max. number of ticks
    "dateFormat" : "Y-m-d"
  },
  "legend" : {
    "show" : "true",
    "font" : "tahoma",
    "size" : "12",
    "xPos" : 100,
    "yPos" : 20
  },
 "seriesFormat" : [
    {
      "name" : "DATACODE1",
      "text" : "Dosage",
      "graphType" : "bar",
      "showValues" : "true",
      "groupFunction" : "max",
      "font" : "tahoma",
      "size" : "12"
    },
    { // This is an additional formatting options set for the serie DATACODE1. In this example we have chosen a 'line' representation and an 'min' group function
      "name" : "DATACODE1",
      "text" : "Dosage (variation)",
      "graphType" : "line",
      "showValues" : "true",
      "groupFunction" : "min",
      "font" : "tahoma",
      "size" : "12"
    },
    {
      "name" : "DATACODE2",
      "text" : "datacode-2",
      "graphType" : "line",     // Options: "line/bar/scatter",
      "showValues" : "true",
      "color" : "",     // Random colors are assigned by default
      "lineWidth" : 1,
      "dotSize" : 5,
      "groupFunction" : "median,max,min",  // formula to use when multiple samples correspond to the same abscise point (avg, median, max, min, sum)
      "font" : "tahoma",
      "size" : "8"
    },
    {
      "name" : "DATACODE3",
      "text" : "datacode-3",
      "graphType" : "line",
      "showValues" : "true",
      "color" : "#ff00ff",
      "groupFunction" : "max",
      "font" : "tahoma",
      "size" : "12",
      "decimals" : "2"
    }
  ]
}

The following graph is a representation of 3 DATACODE series named DATACODE1, DATACODE2 and DATACODE3 using the formatting options of the example

Format in versions GLORIA 3 and lower (deprecated)

In previous versions, the "seriesFormat" property contained a list of object whose key was the name of the serie (usually a DATACODE) and the rest of the formatting options where options of each object.

This format is already supported to maintain backward compatibility but should not be used

SUBSCRIPTION FILTER
{ "title" : {
    "text" : "",
    "font" : "tahoma",
    "size" : "24",
    "color" : "#0000ff",
    "xPos" : 300,
    "yPos" : 20
  },
  "graph" : {
    "width" : 630,
    "height" : 600,
    "areaXPos" : 40,
    "areaYPos" : 20,
    "areaWidth" : 600,
    "areaHeight" : 500,
    "grid" : "true"
  },
  "yAxis" : {
    "min" : 0,  // calculated automatically by default
    "max": 60  // calculated automatically by default
  },
  "xAxis" : {
    "font" : "tahoma",
    "size" : "12",
    "groupBy" : "day",      // Indicates how data should be grouped (day / week / month)
    "fillGaps" : "false",   // Indicates whether to fill gaps between consecutive samples if they are separated by more than a "groupBy" unit
    "ticks" : "10",         // Options: "all"/"all_not_null"/n  n = max. number of ticks
    "dateFormat" : "Y-m-d"
  },
  "legend" : {
    "show" : "true",
    "font" : "tahoma",
    "size" : "12",
    "xPos" : 100,
    "yPos" : 20
  },
 "seriesFormat" : {
    "DATACODE1" : {
       "text" : "Dosage",
       "graphType" : "bar",
       "showValues" : "true",
       "groupFunction" : "max",
       "font" : "tahoma",
       "size" : "12"
       },
    "DATACODE2" : {
        "text" : "datacode-2",
        "graphType" : "line",     // Options: "line/bar/scatter",
        "showValues" : "true",
        "color" : "",     // Random colors are assigned by default
        "lineWidth" : 1,
        "dotSize" : 5,
        "groupFunction" : "median,max,min",  // formula to use when multiple samples correspond to the same abscise point (avg, median, max, min, sum)
        "font" : "tahoma",
        "size" : "8"
        },
    "DATACODE3" : {
        "text" : "datacode-3,
        "graphType" : "line",
        "showValues" : "true",
        "color" : "#ff00ff",
        "groupFunction" : "max",
        "font" : "tahoma",
        "size" : "12",
        "decimals" : "2"
        }
  }
}


Related content