Data Formats

The annotation body border color, or null for no border.

The annotation body border shape.

The annotation body border line style.

The width of the border for the annotation body.

The style of the connector between the annotation and the annotated subject(s).

The annotation body fill color, or null for no fill.

The font size of the annotation body label.

The text for the annotation body.

The color of the text annotation body label.

The position of the annotation relative to the subject(s) it annotates.

The subject or subjects to annotate: string ids for events or EntityRangeSubject objects for ranges of entity activity.

The x position at the left edge of the annotation body.

The x value at the right edge of the annotation body.

The y value at the top of the annotation body.

The y value at the bottom of the annotation body.

The type of drag:

• 'annotationScrollBar' - Scrolls the text of an annotation.
• 'labelAreaWidth' - Changes the width of the entity label area.
• 'lensScrollbar' - Scrolls through lens view.
• 'marqueeRange' - Draws a marquee range. On drag-end, the default action is to zoom into the selected range.
• 'marqueeSelection' - Draws a selection marquee.
• 'moveAnnotation' - Moves the body of an annotation.
• 'pan' - Pans the timeline.
• null - No dragging behavior.

The color of the entity.

Property for storing custom data for the entity.

Controls whether the entity line outside the range of its associated events should be faded.

The glyph drawn for the entity's label.

The text for the entity's label. If not specified, the entity's id is used. See also truncateLabelsAt.

The color of the entity labels.

The width (thickness) of the entity's timeline in pixels. When using expanded rows, only applies to rows, not sub-rows.

The type of the entity as declared in the entityTypes object. If not specified, the 'default' type is used. See the Entity Types docs.

The x position at the left edge of the row containing the entity.

The x value at the right edge of the row containing the entity.

The y value at the top of the row containing the entity.

The y value at the bottom of the row containing the entity.

Id of the entity or entities to annotate.

The time range to annotate for the entity or entities.

The scale wrapping that the annotation should appear for.

The color of the entity.

Controls whether the entity line outside the range of its associated events should be faded.

The glyph drawn for the entity's label.

The color of the entity labels.

The width (thickness) of the entity's timeline in pixels. When using expanded rows, only applies to rows, not sub-rows.

The name of the entity type that this type inherits any unspecified properties from.

The color of entities of this type.

Controls if entity lines outside their range of associated events are faded.

The glyph drawn for the label of entities of this type. If false or not specified, no glyph is drawn.

An array specifying the names of properties on the entity's data object used for grouping entities of this type, innermost first. For example: ['city', 'state', 'country'] will group by city, then state, then country.

The label color for entities of this type.

The line width in pixels for entities of this type.

A number specifying the display order for entities of this type. Entity types with lower values are placed higher. Entities with no specified order appear at the bottom.

The glyph drawn in the label for a group of entities of this type. If false or not specified, no glyph is drawn.

The text used to label a group of entities of this type. If false, no label is shown. If not specified, the type name is used.

The color of the event. Can be either a single color or one of the following values. Also applies to events with more than 2 entities.

• 'from' - Event takes its color from its first 'from' entity.
• 'to' - Event takes its color from its first 'to' entity.
• 'entity' - Event has a color gradient matching the color of each entity it joins with.
• 'inverse' - Event has a color gradient with each end matching the opposite entity's color. For events with more than 2 entities, the color gradient follows the 'from' coloring behavior.

Property for storing custom data for the event.

The ids of entities connected to the event. An event must have at least one connected entity. entityIds may be provided as:

• An array of entity ids, where the event is directed from the first entity to the rest of the entities.
• An object with from and to properties which determine the event direction in relation to each entity. These properties can be either a single string entity id, or an array of entity ids.

Options to define the event's font icon.

Options to define a label for the event line.

The width of the event line.

• If a number, is used directly as the line width in px units.
• If a string, the value of the corresponding property on the event's data object is used instead, and an adjustment is applied to these values to even the distribution of the line widths throughout the dataset.
• If not specified, the value in the event's type is used.

Controls if arrows on the event are shown. If not specified, the value in the event's type is used.

Either a Date in local time, a millisecond number in UTC, or a TimeRange object.

The number of nanoseconds to add to the time value.

The type of the event as declared in the eventTypes object.

If an alt key was held down when the event occurred.

If a consistent control key was held down when the event occurred. cmd key on MacOS, ctrl key on other OSs.

If a control key was held down when the event occurred.

If the meta key was held down when the event occurred.

If a shift key was held down when the event occurred.

The x position corresponding to the start time of the event.

The x position corresponding to the end time of the event.

The y value of the top of the event.

The y value of the bottom of the event.

This property only applies when using Scale Wrapping. An array containing the x positions corresponding to the start and end times for each segment, ordered from left to right as they appear on the timeline. For most events, there is only one segment, so can be ignored.

The color of the event. Can be either a single color or one of the following values. Also applies to events with more than 2 entities.

• 'from' - Event takes its color from its first 'from' entity.
• 'to' - Event takes its color from its first 'to' entity.
• 'entity' - Event has a color gradient matching the color of each entity it joins with.
• 'inverse' - Event has a color gradient with each end matching the opposite entity's color. For events with more than 2 entities, the color gradient follows the 'from' coloring behavior.

Options to define the event's font icon.

Options to define a label for the event line.

The width of the event line in pixels.

Controls if arrows on the event are shown. If not specified, the value in the event's type is used.

The type of the event as declared in the eventTypes object.

The name of the event type that this type inherits any unspecified properties from.

The color of events of this type, either a single color or one of these values. Also applies to events with more than 2 entities.

• 'from' - Event takes its color from its first 'from' entity.
• 'to' - Event takes its color from its first 'to' entity.
• 'entity' - Event has a color gradient matching the color of each entity it joins with.
• 'inverse' - Event has a color gradient with each end matching the opposite entity's color. For events with more than 2 entities, the color gradient follows the 'from' coloring behavior.

Options to define the font icon for events of this type.

Options to define the event-line label for events of this type.

The width of the event line for events of this type.

• If a number, is used directly as the line width in px units.
• If a string, the value of the corresponding property on the event's data object is used instead, and an adjustment is applied to these values to even the distribution of the line widths throughout the dataset.

Controls if arrows should be shown on events of this type.

If mode is 'manual', the ids of the entities whose rows are expanded (if space allows).

The expansion mode being used:

• 'auto' - Expand rows for all the entities.
• 'manual' - Expand rows for just the entities specified in the list of ids.

The URL containing the blob url for the exported image.

The color of the font icon. Default is the timeline's background color.

The horizontal offset as a percentage of the font icon's size.

The vertical offset as a percentage of the font icon's size.

The name of the icon font family.

The weight of the font.

The scale factor of the font icon.

The text of the font icon. Can be an escaped character code or the icon character itself.

The color of the glyph.

The font icon that is drawn on the glyph.

The color to be used for heatmap cells that are greater than or equal to the step value.

The step value.

The color to be used for the heatmap cell.

The event type that one of the heatmap cells underlying events must include.

The color of the label background.

The color of the label text.

The color of the label hint.

The orientation of the label.

The shape of the label.

The text to display in the label.

The name of the icon font family.

The weight of the font.

The text of the font icon. Can be an escaped character code or the icon character itself.

The mode of calculation for the width of the label area:

• 'auto' - The width is calculated automatically based on the visible entities.
• 'fixed' - The width is fixed, but draggable.

The width of the label area.

The color of the marker circle and line.

Options to define the marker's font icon.

The text for the label of the marker.

The color of the marker label.

Whether to show the marker label and circle at the bottom of the timeline.

Whether to show the marker label and circle at the top of the timeline.

Whether to show the vertical marker line. A marker can only be displayed if either showAtTop or showAtBottom is set to 'true'. If both are set to 'false', showLine has no effect and the line is not drawn.

The time that the marker is located at, either a Date in local time, a millisecond number in UTC, or a TimeRange object.

The number of nanoseconds to add to the time value.

The index of the sub-item.

Encoded information unique to the sub-item.

The time property of the sub-item.

The number of nanoseconds to add to the time value.

The value property of the sub-item.

The distance from the left edge of the Timeline element to the center of the sub-item.

The distance from the top edge of the Timeline element to the center of the sub-item.

The width of the sub-item in pixels.

The height of the sub-item in pixels.

The end of the time range as a Date in local time, or a millisecond number in UTC.

The number of nanoseconds to add to the end time value.

The start of the time range as a Date in local time, or a millisecond number in UTC.

The number of nanoseconds to add to the start time value.

The color of the line connecting data points in the time series chart. An alpha value is applied to the area under the chart.

The time series data.

The alpha value applied to the area under the time series chart line. Set to 0 to remove the shaded area.

The label for the time series chart. The label is not shown if the chart is in a stack.

The label color.

The style of line connecting data points in the time series chart.

The type of line connecting data points in the time series chart.

Either a Date in local time or a millisecond number in UTC.

The number of nanoseconds to add to the time value.

The value of the data point.

The ids of the time series charts included in the stack.

The label for the stack.

The stack label's color.