asposediagram.api

Class TimeLineHelper

TimeLineHelper to set property of timeline shape.

Constructor Summary
TimeLineHelper(shape)
TimeLineHelper.
 
Property Getters/Setters Summary
voidsetArrowHead(value)
ArrowHead of timeline shape
voidsetBeginWeek(value)
Begin week of timeline shape
voidsetDateFormatForBE(value)
DateFormat for start and finish of timeline shape
voidsetDateFormatForIntm(value)
DateFormat for Intm of timeline shape
voidsetDateFormatStringForBE(value)
DateFormat String for start and finish of timeline shape
voidsetDateFormatStringForIntm(value)
DateFormat String for Intm of timeline shape
voidsetFiscalStart(value)
First day of fiscal year
voidsetAutoUpdate(value)
whether to update data for markers (milestones, intervals) as they are moved on timeline
voidsetDisplayBE(value)
whether to display Begin and End dates on timeline
voidsetDisplayIntm(value)
whether to display interim date/time ticks on timeline
voidsetDisplayIntmDates(value)
whether to display interim dates on interim ticks
voidsetTimeLineType(value)
Begin week of timeline shape
methodgetTimePeriodFinish()
method
           Time Period for finish of timeline shape
methodgetTimePeriodStart()
method
           Time Period for start of timeline shape
methodgetTimeScale()
method
           scale of timeline shape
 
Method Summary
static methodgetDoubleStringFromDateTime(dateTime)
Convert the date time to double value.
static methodgetWeekEnd(startDate, weekStart)
getweekstart
methodrefreshTimeLine()
Refresh time of timeline shapes
 

    • Constructor Detail

      • TimeLineHelper

        TimeLineHelper(shape)
        TimeLineHelper.
    • Property Getters/Setters Detail

      • setFiscalStart : DateTime 

        setFiscalStart(value)
        
        First day of fiscal year
      • getTimePeriodStart/setTimePeriodStart : DateTime 

        DateTime getTimePeriodStart() / setTimePeriodStart(value)
        
        Time Period for start of timeline shape
      • getTimePeriodFinish/setTimePeriodFinish : DateTime 

        DateTime getTimePeriodFinish() / setTimePeriodFinish(value)
        
        Time Period for finish of timeline shape
      • getTimeScale/setTimeScale : int 

        int getTimeScale() / setTimeScale(value)
        
        scale of timeline shape
      • setArrowHead : int 

        setArrowHead(value)
        
        ArrowHead of timeline shape
      • setBeginWeek : int 

        setBeginWeek(value)
        
        Begin week of timeline shape
      • setTimeLineType : int 

        setTimeLineType(value)
        
        Begin week of timeline shape
      • setDisplayBE : boolean 

        setDisplayBE(value)
        
        whether to display Begin and End dates on timeline
      • setDisplayIntm : boolean 

        setDisplayIntm(value)
        
        whether to display interim date/time ticks on timeline
      • setDisplayIntmDates : boolean 

        setDisplayIntmDates(value)
        
        whether to display interim dates on interim ticks
      • setAutoUpdate : boolean 

        setAutoUpdate(value)
        
        whether to update data for markers (milestones, intervals) as they are moved on timeline
      • setDateFormatForIntm : int 

        setDateFormatForIntm(value)
        
        DateFormat for Intm of timeline shape
        Value Format String 
        0dddd, yyyy-M-d
        1yyyy-MM-dd
        2yy-MMM-d
        3yyyy/M/d
        4yy-MMM.-d
        5d MMMM yyyy
        6yy-M
        7MMM-yy
        8MMMM d, yyyy
        9MMM d, yyyy
        10M-d-yy
        11M-d
        12d MMMM, yyyy
        13d MMM, yyyy
        14d-M-yy
        15d-M
        16yy-M-d
        17yyyy-M-d
        18M-yy
        19M-yyyy
        20MMMM yyyy
        21MMMM yy
        22MMM yyyy
        23MMM yy
        24yy
        25yyyy
        26d
        27MMMM
        28MMM
        29M
        30MM/dd/yyyy
      • setDateFormatStringForIntm : String 

        setDateFormatStringForIntm(value)
        
        DateFormat String for Intm of timeline shape
      • setDateFormatForBE : int 

        setDateFormatForBE(value)
        
        DateFormat for start and finish of timeline shape
        Value Format String 
        0dddd, yyyy-M-d
        1yyyy-MM-dd
        2yy-MMM-d
        3yyyy/M/d
        4yy-MMM.-d
        5d MMMM yyyy
        6yy-M
        7MMM-yy
        8MMMM d, yyyy
        9MMM d, yyyy
        10M-d-yy
        11M-d
        12d MMMM, yyyy
        13d MMM, yyyy
        14d-M-yy
        15d-M
        16yy-M-d
        17yyyy-M-d
        18M-yy
        19M-yyyy
        20MMMM yyyy
        21MMMM yy
        22MMM yyyy
        23MMM yy
        24yy
        25yyyy
        26d
        27MMMM
        28MMM
        29M
        30MM/dd/yyyy
      • setDateFormatStringForBE : String 

        setDateFormatStringForBE(value)
        
        DateFormat String for start and finish of timeline shape
    • Method Detail

      • refreshTimeLine

         refreshTimeLine()
        Refresh time of timeline shapes

        Example:

        var aspose = aspose || {};
        aspose.diagram = require("aspose.diagram");
        
        diagram = new aspose.diagram.Diagram("DrawingTimeLine.vsdx");
        
        shapeid = 1;
        // Get timeline shape
        timeline = diagram.getPages().getPage("Page-1").getShapes().getShape(shapeid);
        
        // Initialize TimeLineHlper object
        timelineHelper = new aspose.diagram.TimeLineHelper(timeline);
        
        // Set start time
        timelineHelper.setTimePeriodStart(new aspose.diagram.DateTime(2014, 12, 21));
        // Set end time
        timelineHelper.setTimePeriodFinish(new aspose.diagram.DateTime(2015, 2, 19));
        
        // Set date format
        timelineHelper.setDateFormatForBE(21);
        
        // revive milestones on the timeline
        timelineHelper.refreshTimeLine();
        
        diagram.save("out-RefreshTimeLine.vsdx", aspose.diagram.SaveFileFormat.VSDX);
      • getWeekEnd

        static DateTime getWeekEnd(startDate, weekStart)
        getweekstart
        Parameters:
        startDate: DateTime -
        weekStart: int - (0sunday 1monday 2 3 4 5 6)
        Returns:
      • getDoubleStringFromDateTime

        static String getDoubleStringFromDateTime(dateTime)
        Convert the date time to double value.
        Parameters:
        dateTime: DateTime - The date time.
        Returns: