跳至主要内容
文档
文档
Adaptive Planning
上次更新时间 ：2023-06-23
ai.calendar

ai.calendar

可包含原始数据或聚合数据的时段。请参见 步骤：更改日历。

函数

方法
参数
退货
描述
getNextPeriod( period [, options ] )
  • period：字符串 要获取其下一个时段的期间的值
  • options: Object 对象，包含一个类型属性“number”和一个整型值属性。示例：{type: 'number', value: 3}
ai.calendar.period
返回中的下一个期间。
Adaptive Planning
 从参数中传递的期间开始的日历
getPreviousPeriod( period [, options ] )
  • period：字符串 要获取其上一时段的期间的值
  • options: Object 对象，包含一个类型属性“number”和一个整型值属性。示例：{type: 'number', value: 3}
ai.calendar.period
返回中的上一个期间。
Adaptive Planning
 从参数中传递的期间开始的日历
getAvailablePeriodTypes( periodType )
  • periodType：可用时间层级之一的字符串时间层级代码。
数组 <String>
返回在层次结构中比传入的时间层级更高的日历支持的时间层级（期间类型）代码的数组（例如 ['QuarterYear', 'HalfYear', 'Year'] ）
getPeriodStartDateTime( period )
  • period: ai.calendar.period 要获取开始日期时间的期间
String
以 ISO8601 日期字符串格式返回期间的开始日期时间（例如“2015-06-15T12:00:00+10:00”）。
getPeriodEndDateTime( period )
  • period: ai.calendar.period 要获取其结束日期时间的期间
String
以 ISO8601 日期字符串格式返回期间的结束日期时间（例如“2015-06-15T12:00:00+10:00”）。
convertToAdaptivePeriodStart ( start, end )
  • start：要转换的期间的开始日期，采用 ISO8601 格式的字符串
  • end：要转换的期间的结束日期（采用 ISO8601 格式）
String
返回相应的
Adaptive Planning
 期间开始日期，采用 ISO8601 日期字符串格式（例如“2015-06-15T12:00:00+10:00”）
isWithinAdaptivePeriodRange ( start, end, periodFrom, periodEnd )
  • start：要转换的期间的开始日期，采用 ISO8601 格式的字符串
  • end：要转换的期间的结束日期（采用 ISO8601 格式）
  • periodFrom: ai.calendar.period 要进行比较的起始期间
  • periodEnd: ai.calendar.period 要与之比较的期间
Boolean
如果给定的开始日期和结束日期都在“开始期间”和“结束期间”这两个期间内，则返回“真”。否则返回 false。 （例如 true/false）

示例

getNextPeriod( period [, options ] ) 和 getPeviousPeriod( period [, options ] ) 的示例

function PreviewData(context) {
   var calendar = context.getCalendar();
   var dataSource = context.getDataSource();
   var periods = dataSource.getSetting("Periods").getValue();
   // getNextPeriod
   var nextMonth = calendar.getNextPeriod(periods.getFromPeriod());
   //getPreviousPeriod
   var prevMonth = calendar.getPreviousPeriod(periods.getFromPeriod());
}
示例：convertToAdaptivePeriodStart ( start, end ) 

function PreviewData(context) {
   var calendar = context.getCalendar();
   var newDate = calendar.convertToAdaptivePeriodStart(ai.date.create('2016-02-01', 'America/Los_Angeles'), ai.date.create('2016-05-01', 'America/Los_Angeles'));
   // write the corresponding Adaptive Planning period start date to log.  
   ai.log.logInfo(newDate);
  //Assuming server is in PST timezone, the corresponding output is '2016-04-01T00:00:00.0000000-07:00'
}
以下示例适用于 getAvailablePeriodTypes( periodType ) 

 function PreviewData(context) {
   var dataSource = context.getDataSource();
   var calendar = context.getCalendar();
   var availableTypeMonth = calendar.getAvailablePeriodTypes('month');
   var availableTypeQuarter = calendar.getAvailablePeriodTypes('qtr');
   var availableTypeYear = calendar.getAvailablePeriodTypes('year');
   ai.log.logInfo("Stratum code of one of the available Strata for month: "+availableTypeMonth);
   ai.log.logInfo("Stratum code of one of the available Strata for quarter: "+availableTypeQuarter);
   ai.log.logInfo("Stratum code of one of the available Strata for year: "+availableTypeYear);
  }
   //Stratum code of one of the available Strata for month: month,qtr,year
   //Stratum code of one of the available Strata for quarter: qtr,year
   //Stratum code of one of the available Strata for year: year

ai.calendar.period

可包含原始数据或聚合数据的时段。
函数
方法
参数
退货
描述
getValue()
字符串
返回“期间”子列的字符串值，这些值可作为参数传递给“日历”函数。
示例

function PreviewData(context) {
   var dataSource = context.getDataSource();
   var calendar = context.getCalendar();
   var periods = dataSource.getSetting("Periods").getValue();
   var period = calendar.nextPeriod(periods.getFromPeriod());
   var nextPeriod = calendar.nextPeriod(period.getValue());
}