Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetData

Gets BI data based on the given Labels.

  • OrganizationUnitID is the organization unit you want data from; this may be a container unit or a shop alike
  • Labels define the data you want to retrieve; use GetLabels to find the available labels in this instance
  • Timeframe defines the range of dates you want to accumulate, where you have three options available;
    • A Period with a Year and then either a Month or a Week (ISO)
    • A Range with a From and To date and a Grain to define the amount of detail within this period
    • A Date for a single date point in time

Optionally, you can supply the following parameters;

  • Series is an array where you can specify which Series to retrieve; current values include Actual and LFL
  • GroupBy defines the 'rotation' to view the data in; by default you'll see data per Label, but you can rotate for a ranking view using OrganizationUnit or a more detailed view using Name
  • Mock allows you to override the base BI:Mock setting to switch between mocked- and live data

Hierarchy

  • GetData

Index

Properties

GroupBy

GroupBy: GroupBy

Optional Labels

Labels: string[]

Optional Mock

Mock: undefined | false | true

OrganizationUnitID

OrganizationUnitID: number

Optional Series

Series: Series[]

Optional Timeframe

Timeframe: Timeframe