TimeLineHelper

TimeLineHelper class

TimeLineHelper to set property of timeline shape.

Constructors

Name	Description
TimeLineHelper	TimeLineHelper.

Properties

Name	Type	Description
FiscalStart	DateTime	First day of fiscal year
TimePeriodStart	DateTime	Time Period for start of timeline shape
TimePeriodFinish	DateTime	Time Period for finish of timeline shape
TimeScale	int	scale of timeline shape
ArrowHead	int	ArrowHead of timeline shape
BeginWeek	int	Begin week of timeline shape
TimeLineType	int	Begin week of timeline shape
IsDisplayBE	boolean	whether to display Begin and End dates on timeline
IsDisplayIntm	boolean	whether to display interim date/time ticks on timeline
IsDisplayIntmDates	boolean	whether to display interim dates on interim ticks
IsAutoUpdate	boolean	whether to update data for markers (milestones, intervals) as they are moved on timeline
DateFormatForIntm	int	DateFormat for Intm of timeline shape Value Format String 0 dddd, yyyy-M-d 1 yyyy-MM-dd 2 yy-MMM-d 3 yyyy/M/d 4 yy-MMM.-
DateFormatStringForIntm	String	DateFormat String for Intm of timeline shape
DateFormatForBE	int	DateFormat for start and finish of timeline shape Value Format String 0 dddd, yyyy-M-d 1 yyyy-MM-dd 2 yy-MMM-d 3 yyyy/M/
DateFormatStringForBE	String	DateFormat String for start and finish of timeline shape

Methods

Name	Description
refreshTimeLine	Refresh time of timeline shapes
getWeekEnd	getweekstart
getDoubleStringFromDateTime	Convert the date time to double value.

TimeLineHelper(shape)

TimeLineHelper.

TimeLineHelper.FiscalStart property

First day of fiscal year

Type: DateTime

TimeLineHelper.TimePeriodStart property

Time Period for start of timeline shape

Type: DateTime

TimeLineHelper.TimePeriodFinish property

Time Period for finish of timeline shape

Type: DateTime

TimeLineHelper.TimeScale property

scale of timeline shape

Type: int

TimeLineHelper.ArrowHead property

ArrowHead of timeline shape

Type: int

TimeLineHelper.BeginWeek property

Begin week of timeline shape

Type: int

TimeLineHelper.TimeLineType property

Begin week of timeline shape

Type: int

TimeLineHelper.IsDisplayBE property

whether to display Begin and End dates on timeline

Type: boolean

TimeLineHelper.IsDisplayIntm property

whether to display interim date/time ticks on timeline

Type: boolean

TimeLineHelper.IsDisplayIntmDates property

whether to display interim dates on interim ticks

Type: boolean

TimeLineHelper.IsAutoUpdate property

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

Type: boolean

TimeLineHelper.DateFormatForIntm property

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

Type: int

TimeLineHelper.DateFormatStringForIntm property

DateFormat String for Intm of timeline shape

Type: String

TimeLineHelper.DateFormatForBE property

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

Type: int

TimeLineHelper.DateFormatStringForBE property

DateFormat String for start and finish of timeline shape

Type: String

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(startDate, weekStart)

getweekstart

Parameter	Type	Description
startDate	DateTime
weekStart	int	(0sunday 1monday 2 3 4 5 6)

getDoubleStringFromDateTime(dateTime)

Convert the date time to double value.

Parameter	Type	Description
dateTime	DateTime	The date time.

ThreeDFormat ToPartValue