aspose.diagram
Class TimeLineHelper

TimeLineHelper to set property of timeline shape.

Constructor Summary
TimeLineHelper(shape)
           TimeLineHelper.
 
Property Getters/Setters Summary
functionsetArrowHead(value)
           ArrowHead of timeline shape
functionsetBeginWeek(value)
           Begin week of timeline shape
functionsetDateFormatForBE(value)
           DateFormat for start and finish of timeline shape
functionsetDateFormatForIntm(value)
           DateFormat for Intm of timeline shape
functionsetDateFormatStringForBE(value)
           DateFormat String for start and finish of timeline shape
functionsetDateFormatStringForIntm(value)
           DateFormat String for Intm of timeline shape
functionsetAutoUpdate(value)
           whether to update data for markers (milestones, intervals) as they are moved on timeline
functionsetDisplayBE(value)
           whether to display Begin and End dates on timeline
functionsetDisplayIntm(value)
           whether to display interim date/time ticks on timeline
functionsetDisplayIntmDates(value)
           whether to display interim dates on interim ticks
functionsetTimeLineType(value)
           Begin week of timeline shape
functiongetTimePeriodFinish()
           Time Period for finish of timeline shape
functiongetTimePeriodStart()
           Time Period for start of timeline shape
functiongetTimeScale()
functionsetTimeScale(value)
           scale of timeline shape
 
Method Summary
functionrefreshTimeLine()
           Refresh time of timeline shapes
 

Constructor Detail

TimeLineHelper

function TimeLineHelper(shape)
TimeLineHelper.

Property Getters/Setters Detail

getTimePeriodStart : DateTime 

function getTimePeriodStart()
Time Period for start of timeline shape

getTimePeriodFinish : DateTime 

function getTimePeriodFinish()
Time Period for finish of timeline shape

getTimeScale/setTimeScale : Number 

function getTimeScale() / function setTimeScale(value)
scale of timeline shape

setArrowHead : Number 

function setArrowHead(value)
ArrowHead of timeline shape

setBeginWeek : Number 

function setBeginWeek(value)
Begin week of timeline shape

setTimeLineType : Number 

function setTimeLineType(value)
Begin week of timeline shape

setDisplayBE : boolean 

function setDisplayBE(value)
whether to display Begin and End dates on timeline

setDisplayIntm : boolean 

function setDisplayIntm(value)
whether to display interim date/time ticks on timeline

setDisplayIntmDates : boolean 

function setDisplayIntmDates(value)
whether to display interim dates on interim ticks

setAutoUpdate : boolean 

function setAutoUpdate(value)
whether to update data for markers (milestones, intervals) as they are moved on timeline

setDateFormatForIntm : Number 

function 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 

function setDateFormatStringForIntm(value)
DateFormat String for Intm of timeline shape

setDateFormatForBE : Number 

function 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 

function setDateFormatStringForBE(value)
DateFormat String for start and finish of timeline shape

Method Detail

refreshTimeLine

function 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);

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.