Series Config

Series config can be added for individual serie in a view. It is accessed in View Settings by clicking the button and then the button next to the serie name. Each serie has View config and Default config. You can use the Default config to change the configuration for this serie in all views and workspaces. The View config only applies to this serie in the current view. The View config overrides the Default config.

excluded (boolean) false

Excludes serie from the query and will not be present in the grid. Use the button to toggle.

pinned (boolean) false

The pinned setting specifies whether or not the serie can be excluded (see above) by the user in simple plan view settings mode. Use the button to toggle.

edit (object)

Makes serie editable in grid. Editing can be enabled or disabled, either for the whole series or for a specific relative time period.

  • enabled: (boolean) default from db config: Override the editability of the serie.
  • checkboxes: (object): Changes serie values to checkboxes. More here.
  • action (string) “update_value”: The action that will be executed after value has been changed in grid. The default action is update_value which should be able to handle most updates. More here.
  • actionArgs (object): Action parameters. More here.
  • toggleEditableRelativeToCurrent (object): Toggles editability depending on dates. More here.

Toggle editability relative to current

Specify which time periods will have different editability. The value of this key should be an object whose keys are the name of period captions. Each such object has a from and to keys that specify the period (relative to current period) that should have the opposite editability. The example below specifies that the serie is not editable, except for the period between 5 to 3 weeks before the current week.

{
  "edit": {
    "enabled": true,
    "action": "update_value",
    "actionArgs": {},
    "toggleEditableRelativeToCurrent": {
      "caption_planning_week": {
        "from": -5,
        "to": -3
      }
    }
  }
}

To make series editable in the future:

{
  "edit": {
    "enabled": true,
    "toggleEditableRelativeToCurrent": {
      "caption_day_short": { "from": 1, "to": 9999 },
      "caption_month_short": { "from": 1, "to": 9999 },
      "caption_week_short": { "from": 1, "to": 9999 }
    }
  }
}

format (object)

Controls the formatting and behavior of data in grid. Mostly, these configurations override the settings of the data series as they are set up in the database (in the data_elements table). Additionally, checkbox configuration is set up here.

{
  "format": {
    "caption": "Some caption",
    "format": "percentage:2",
    "displayDiv": 100
  }
}
  • caption: (string) default from db config: Overrides the caption of the serie, as displayed in the data series column in the grid.
  • displayDiv: (number) default from db config: Divides number shown in grid by number provided.
  • format: (string) default from db config: Overrides the format of the data serie. For more information, see Settings -> System -> Format Tester in the AGR app.