Entity

Entity is derived class of VertexElem and represents an entity.

Fields

Field	Type	Description
isEntity	boolean	Read only. Returns True.
title	string	The title of the Entity.
confidence	number	The confidence, as a value between 0.0 and 1.0.
canDrive	boolean	Read Only. True if this entity can drive confidence; i.e., it has no predecessors ignoring back edges.
completion	number	Read Only. The completion, as a value between 0.0 and 1.0. Zero if project management not enabled.
effortHours	number	The effort in hours, as a positive floating-point value or zero for a milestone. Zero if project management not enabled.
effort		This field is deprecated, use effortHours instead. The effort in days where one day is the document default work hours, as a positive value or zero for a milestone. Zero if project management not enabled.
startDate	Date or None	The start date, as a Date. None if project management not enabled.
endDate	Date or None	The end date, as a Date. None if project management not enabled.
resources	list of Resource	Read only. A list of resources assigned to a task. The list can be empty.
resourceAssignment	Resource Assignment Type	The current setting for how resources are assigned to a task.
symbol	Symbol or None	The directly set symbol for this entity, as a Symbol, otherwise None.
inheritedSymbol	Symbol or None	Read only. The symbol for this entity, either the directly set Symbol or the one inherited from its EntityClass. None if both values are None.
entityClass	EntityClass	The class of the Entity.
entityID	integer	Read only. The element’s entity ID. Can be zero if entityID are not currently visible.
chartRowEffortString	string	Read only. The string that would be displayed for the entity’s effort in chart view or None is project management not enabled.
preferredStartDate	Date or None	The preferred start date, as a Date. None if the entity has no preferred start date or project management not enabled.
preferredFinishDate	Date or None	The preferred finish date, as a Date. None if the entity has no preferred finish date or project management not enabled.
preferredDateError	boolean	Read only. Set to True if the entity exhibits a date error, otherwise False.
resourceString	string or None	Read only. The string that would be displayed for the entity’s resources in graph view, or None if no resources assigned or project management not enabled.
chartRowResourceString	string or None	Read only. The string that would be displayed for the entity’s resources in chart view, or None if no resources assigned or project management not enabled.
startDateString	Date or None	Read only. The string that would be displayed for the entity’s start date, or None if project management not enabled.
finishDateString	Date or None	Read only. The string that would be displayed for the entity’s finish date, or None if project management not enabled.
titleFont	FontSpec	Read only. The FontSpec used to render the entity title.
titleLines	list of LayoutLine	Read only. A list of LayoutLines providing position information for the entity title.

Methods

equals( object )

Returns True if object represents the same entity as self.

addResource( resource )

Assigns the given resource to the task.

removeResource( resource )

Removes the given resource assigned to the task.