Gantt Supporting Types

Supporting types used to configure behaviour, appearance, and interaction of Gantt views.

These are typically passed as arguments to views or task definitions.

class Dependencies(point_ids_source_field)

Bases: Buildable

Configures task dependencies for Gantt chart visualization.

Defines relationships between tasks by mapping dependency information to a source field containing an array of related task IDs.

Parameters:

point_ids_source_field (Field) – Field containing an array of valid task IDs that this task depends on.

class DragDropHandleBehaviour(*values)

Bases: Enum

Specifies how drag-and-drop handles behave for Gantt chart tasks.

START_AND_END

Both the start and end of a task can be adjusted by dragging.

START_ONLY

Only the start time of the task can be dragged.

END_ONLY

Only the end time of the task can be dragged.

NONE

Drag handles are disabled; tasks cannot be resized.

START_AND_END = 'START_AND_END'

START_ONLY = 'START_ONLY'

END_ONLY = 'END_ONLY'

NONE = 'NONE'

class DragDropSnapInterval(*values)

Bases: Enum

Determines the snapping behaviour when a user drags a task along the Gantt chart x-axis.

MINUTE

Snap dragged positions to 1-minute increments.

FIVE_MINUTES

Snap positions to 5-minute increments.

QUARTER_HOUR

Snap positions to 15-minute increments.

HOUR

Snap positions to hourly increments.

DAY

Snap positions to full-day increments.

MINUTE = 'MINUTE'

FIVE_MINUTES = 'FIVE_MINUTES'

QUARTER_HOUR = 'QUARTER_HOUR'

HOUR = 'HOUR'

DAY = 'DAY'

class RangeSelectorButton(type, count, text)

Bases: Buildable

Represents a button used in the Gantt or chart range selector.

type

The type of range selector option (e.g., DAY, WEEK, MONTH).

Type:

RangeSelectorButtonType

count

A numeric value associated with the range (e.g., 7 days, 3 months).

Type:

int

text

Optional display text shown on the button.

Type:

str

type: RangeSelectorButtonType

count: int

text: str

class RangeSelectorButtonType(*values)

Bases: Enum

Defines the time unit types available for range selector buttons.

HOUR

Selects a range measured in hours.

DAY

Selects a range measured in days.

WEEK

Selects a range measured in weeks.

MONTH

Selects a range measured in months.

YEAR

Selects a range measured in years.

YTD

Selects a year-to-date range (from start of year to current date).

ALL

Selects the entire available date range.

HOUR = 'HOUR'

DAY = 'DAY'

WEEK = 'WEEK'

MONTH = 'MONTH'

YEAR = 'YEAR'

YTD = 'YTD'

ALL = 'ALL'

class TooltipBoundary(*values)

Bases: Enum

Determines the positional constraint applied when displaying tooltips within the Gantt chart.

WITHIN_CHART

The tooltip must remain within chart boundaries.

NO_BOUNDARY

The tooltip may render outside chart boundaries if needed.

WITHIN_CHART = 'WITHIN_CHART'

NO_BOUNDARY = 'NO_BOUNDARY'

class TooltipProperty(property_type, property_name, value_source_field)

Bases: Buildable

Defines a single property to display in a Gantt chart task tooltip.

Configures what information appears when hovering over or interacting with a task, including predefined properties (start/end dates) or custom field values.

type

The type of tooltip property (START_DATE, END_DATE, or CUSTOM).

property_name

The display name for this property in the tooltip.

value_source_field

The field ID containing the value to display.

__init__(property_type, property_name, value_source_field)

Initialize a TooltipProperty instance.

Parameters:

• property_type (TooltipPropertyType) – The type of property to display in the tooltip.

• property_name (str) – The label to show for this property.

• value_source_field (Field) – The field containing the value to display.

class TooltipPropertyType(*values)

Bases: Enum

Defines the types of tooltip properties that can be shown for a Gantt chart task.

START_DATE

Display the task’s start date in the tooltip.

END_DATE

Display the task’s end date in the tooltip.

CUSTOM

Display a custom field value based on the configuration.

START_DATE = 'START_DATE'

END_DATE = 'END_DATE'

CUSTOM = 'CUSTOM'

class XAxisHeader(*values)

Bases: Enum

Defines the available header interval types for the Gantt chart x-axis.

QUARTER_HOUR

Displays x-axis headers at 15-minute intervals.

HOUR

Displays x-axis headers at hourly intervals.

HOUR_24

Displays x-axis headers at hourly intervals, with 24hr time.

DAY

Displays x-axis headers daily.

WEEK

Displays x-axis headers weekly, displaying start day of week.

WEEK_LARGE

Displays x-axis headers weekly, displaying start day of week in extended format. Useful for top header row

CALENDAR_WEEK

Displays x-axis headers weekly, based on calendar week.

MONTH

Displays x-axis headers monthly.

YEAR

Displays x-axis headers yearly.

STANDARD_SCALING

Standard dynamic scaling, with AM/PM times.

STANDARD_SCALING_24

Standard dynamic scaling, with 24hr times.

CALENDAR_WEEK_SCALING

Calendar week dynamic scaling, with AM/PM times.

CALENDAR_WEEK_SCALING_24

Calendar week dynamic scaling, with 24hr times.

STANDARD_TOP_ROW

Top row (year-month-week-day) dynamic scaling.

CALENDAR_WEEK_TOP_ROW

Top row (year-month-week-day) dynamic scaling with calendar weeks.

QUARTER_HOUR = 'QUARTER_HOUR'

HOUR = 'HOUR'

HOUR_24 = 'HOUR_24'

DAY = 'DAY'

WEEK = 'WEEK'

WEEK_LARGE = 'WEEK_LARGE'

CALENDAR_WEEK = 'CALENDAR_WEEK'

MONTH = 'MONTH'

YEAR = 'YEAR'

STANDARD_SCALING = 'STANDARD_SCALING'

STANDARD_SCALING_24 = 'STANDARD_SCALING_24'

CALENDAR_WEEK_SCALING = 'CALENDAR_WEEK_SCALING'

CALENDAR_WEEK_SCALING_24 = 'CALENDAR_WEEK_SCALING_24'

STANDARD_TOP_ROW = 'STANDARD_TOP_ROW'

CALENDAR_WEEK_TOP_ROW = 'CALENDAR_WEEK_TOP_ROW'

class FontProperties(font_color_source_field=None, font_weight_source_field=None, font_style_source_field=None)

Bases: Buildable

Configures font styling properties for Gantt chart tasks.

Allows customization of text appearance by mapping font attributes to source fields in the underlying data.

Parameters:

• font_color_source_field (Field | None) – Field containing the color value for task text.

• font_weight_source_field (Field | None) – Field containing the font weight.

• font_style_source_field (Field | None) – Field containing the font style.

class IconProperties(icon_source_source_field=None, icon_color_source_field=None)

Bases: Buildable

Configures icon properties for Gantt chart tasks.

Allows customization of task icons by mapping icon attributes to source fields in the underlying data.

Parameters:

• icon_source_source_field (Field | None) – Field containing the icon identifier or source.

• icon_color_source_field (Field | None) – Field containing the color value for the icon.