Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%ZEN.Report.Display.timeline

class %ZEN.Report.Display.timeline extends %ZEN.Report.Display.childrenNode

Property Inventory

Method Inventory

Properties

property BackgroundColor as %ZEN.Datatype.string (XMLNAME = "background-color") [ InitialExpression = "'white'" ];
background-color: when we graph episodes - the background color
Property methods: BackgroundColorDisplayToLogical(), BackgroundColorGet(), BackgroundColorIsValid(), BackgroundColorLogicalToDisplay(), BackgroundColorLogicalToOdbc(), BackgroundColorNormalize(), BackgroundColorSet()
property CurrentDate as %ZEN.Datatype.string (XMLNAME = "current-date");
current-date is by default date of generation of report and indicated by a downward pointing arrow.
Property methods: CurrentDateDisplayToLogical(), CurrentDateGet(), CurrentDateIsValid(), CurrentDateLogicalToDisplay(), CurrentDateLogicalToOdbc(), CurrentDateNormalize(), CurrentDateSet()
property EndDate as %ZEN.Datatype.string (XMLNAME = "static-end-date");
static-end-date can be used to override automatic calculation of end date from data
Property methods: EndDateDisplayToLogical(), EndDateGet(), EndDateIsValid(), EndDateLogicalToDisplay(), EndDateLogicalToOdbc(), EndDateNormalize(), EndDateSet()
property EndDateNodeSet as %ZEN.Datatype.string (XMLNAME = "end-date-node-set");
end-date-node-set is the xpath expression for end-dates. It corresponds to start dates and episode types through predicate [position()=$pos]
Property methods: EndDateNodeSetDisplayToLogical(), EndDateNodeSetGet(), EndDateNodeSetIsValid(), EndDateNodeSetLogicalToDisplay(), EndDateNodeSetLogicalToOdbc(), EndDateNodeSetNormalize(), EndDateNodeSetSet()
property EpisodeTypeNodeSet as %ZEN.Datatype.string (XMLNAME = "episode-type-node-set");
episode-type-node-set is the xpath expression for episode-types. It corresponds to start dates and end dates through predicate [position()=$pos]
Property methods: EpisodeTypeNodeSetDisplayToLogical(), EpisodeTypeNodeSetGet(), EpisodeTypeNodeSetIsValid(), EpisodeTypeNodeSetLogicalToDisplay(), EpisodeTypeNodeSetLogicalToOdbc(), EpisodeTypeNodeSetNormalize(), EpisodeTypeNodeSetSet()
property GeneratedTypeCode as %ZEN.Datatype.string (XMLNAME = "generated-type-code");
generated-type-code is a string or integer that indicates when an episode is generated
Property methods: GeneratedTypeCodeDisplayToLogical(), GeneratedTypeCodeGet(), GeneratedTypeCodeIsValid(), GeneratedTypeCodeLogicalToDisplay(), GeneratedTypeCodeLogicalToOdbc(), GeneratedTypeCodeNormalize(), GeneratedTypeCodeSet()
property GeneratedTypeColor as %ZEN.Datatype.string (XMLNAME = "generated-type-color") [ InitialExpression = "'gray'" ];
generated-type-color is the color with which generated episodes will be drawn
Property methods: GeneratedTypeColorDisplayToLogical(), GeneratedTypeColorGet(), GeneratedTypeColorIsValid(), GeneratedTypeColorLogicalToDisplay(), GeneratedTypeColorLogicalToOdbc(), GeneratedTypeColorNormalize(), GeneratedTypeColorSet()
property IntervalHeight as %ZEN.Datatype.string (XMLNAME = "interval-height");
interval-height is the height of episode ticks and xaxis ticks
Property methods: IntervalHeightDisplayToLogical(), IntervalHeightGet(), IntervalHeightIsValid(), IntervalHeightLogicalToDisplay(), IntervalHeightLogicalToOdbc(), IntervalHeightNormalize(), IntervalHeightSet()
property IntervalType as %ZEN.Datatype.string (VALUELIST = ",'year','quarter','month','day'", XMLNAME = "interval-type");
interval-type is the type of interval with which we are dealing, year, quarter, month or day
Property methods: IntervalTypeDisplayToLogical(), IntervalTypeGet(), IntervalTypeIsValid(), IntervalTypeLogicalToDisplay(), IntervalTypeLogicalToOdbc(), IntervalTypeNormalize(), IntervalTypeSet()
property MaxHeight as %ZEN.Datatype.integer (XMLNAME = "max-height") [ InitialExpression = 5 ];
max-height specifies the maximum height of the episode graph. Unseen episodes will be indicated with an up-arrow.
Property methods: MaxHeightDisplayToLogical(), MaxHeightGet(), MaxHeightIsValid(), MaxHeightLogicalToDisplay(), MaxHeightLogicalToOdbc(), MaxHeightNormalize(), MaxHeightSet()
property MinimumIntervalWidth as %ZEN.Datatype.string (XMLNAME = "minimum-interval-width");
minimum-interval-width is the width of an interval in the timeline. An interval can be a day, a month, a quarter or a year This is in mm - milimeters It is an xpath expression so specified as "'10mm'" for instance
Property methods: MinimumIntervalWidthDisplayToLogical(), MinimumIntervalWidthGet(), MinimumIntervalWidthIsValid(), MinimumIntervalWidthLogicalToDisplay(), MinimumIntervalWidthLogicalToOdbc(), MinimumIntervalWidthNormalize(), MinimumIntervalWidthSet()
property NumberOfIntervals as %ZEN.Datatype.integer (XMLNAME = "number-of-intervals");
number-of-intervals can be used to override automatic calculation from data
Property methods: NumberOfIntervalsDisplayToLogical(), NumberOfIntervalsGet(), NumberOfIntervalsIsValid(), NumberOfIntervalsLogicalToDisplay(), NumberOfIntervalsLogicalToOdbc(), NumberOfIntervalsNormalize(), NumberOfIntervalsSet()
property OffColor as %ZEN.Datatype.string (XMLNAME = "off-color") [ InitialExpression = "'white'" ];
off-color: In the xaxis label, the color of intervals when they are "off"
Property methods: OffColorDisplayToLogical(), OffColorGet(), OffColorIsValid(), OffColorLogicalToDisplay(), OffColorLogicalToOdbc(), OffColorNormalize(), OffColorSet()
property OnColor as %ZEN.Datatype.string (XMLNAME = "on-color") [ InitialExpression = "'gray'" ];
on-color: In the xaxis label, the color of intervals when they are "on"
Property methods: OnColorDisplayToLogical(), OnColorGet(), OnColorIsValid(), OnColorLogicalToDisplay(), OnColorLogicalToOdbc(), OnColorNormalize(), OnColorSet()
property PlottingColor as %ZEN.Datatype.string (XMLNAME = "plotting-color") [ InitialExpression = "'black'" ];
plotting-color: when we graph episodes - the foreground color
Property methods: PlottingColorDisplayToLogical(), PlottingColorGet(), PlottingColorIsValid(), PlottingColorLogicalToDisplay(), PlottingColorLogicalToOdbc(), PlottingColorNormalize(), PlottingColorSet()
property StartDate as %ZEN.Datatype.string (XMLNAME = "static-start-date");
static-start-date can be used to override automatic calculation of start date from data
Property methods: StartDateDisplayToLogical(), StartDateGet(), StartDateIsValid(), StartDateLogicalToDisplay(), StartDateLogicalToOdbc(), StartDateNormalize(), StartDateSet()
property StartDateNodeSet as %ZEN.Datatype.string (XMLNAME = "start-date-node-set");
start-date-node-set is the xpath expression for start-dates. It corresponds to end dates and episode types through predicate [position()=$pos]
Property methods: StartDateNodeSetDisplayToLogical(), StartDateNodeSetGet(), StartDateNodeSetIsValid(), StartDateNodeSetLogicalToDisplay(), StartDateNodeSetLogicalToOdbc(), StartDateNodeSetNormalize(), StartDateNodeSetSet()
property field as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Property methods: fieldDisplayToLogical(), fieldGet(), fieldIsValid(), fieldLogicalToDisplay(), fieldLogicalToOdbc(), fieldNormalize(), fieldSet()
property group as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Property methods: groupDisplayToLogical(), groupGet(), groupIsValid(), groupLogicalToDisplay(), groupLogicalToOdbc(), groupNormalize(), groupSet()
property removeEmpty as %ZEN.Datatype.boolean (XMLPROJECTION = "NONE") [ InitialExpression = 0 ];
Property methods: removeEmptyDisplayToLogical(), removeEmptyGet(), removeEmptyIsValid(), removeEmptyLogicalToDisplay(), removeEmptyLogicalToOdbc(), removeEmptyLogicalToXSD(), removeEmptyNormalize(), removeEmptySet(), removeEmptyXSDToLogical()

Methods

method %DrawToHTML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream, incell As %Boolean = 0) as %Status
Inherited description: This method outputs the necessary stylesheet information for the HTML report. Every tag should override this method.
method %DrawToXSLFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream, ByRef incell As %Boolean) as %Status
Inherited description: This method outputs the necessary stylesheet information for the PDF report. Every tag should override this method.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab