๐Ÿ‘‰Constants

Collections of constants used throughout the Flying Logic scripting API.

All the constants in this section are defined in the Application class.

Orientation Type

ORIENTATION_LEFT_TO_RIGHT
ORIENTATION_RIGHT_TO_LEFT
ORIENTATION_TOP_TO_BOTTOM
ORIENTATION_BOTTOM_TO_TOP
ORIENTATION_INNER_TO_OUTER
ORIENTATION_OUTER_TO_INNER

Example:

Application.defaultOrientation = Application.ORIENTATION_LEFT_TO_RIGHT

Bias Type

BIAS_START
BIAS_END

Example:

Application.defaultBias = Application.BIAS_START

Compactness Type

COMPACTNESS_RELAXED
COMPACTNESS_COMFORTABLE
COMPACTNESS_COMPACT

Example:

Application.graphCompactness = Application.COMPACTNESS_COMFORTABLE

Animation Style Type

ANIMATION_FIXED_FRAME_RATE
ANIMATION_FIXED_TIME

Example:

Application.animationStyle = Application.ANIMATION_FIXED_FRAME_RATE

Edge Colors Type

EDGE_RED_GRAY_BLACK
EDGE_RED_YELLOW_BLACK
EDGE_RED_YELLOW_GREEN

Example:

Application.edgeColors = Application.EDGE_RED_GRAY_BLACK

Spinner Display Type

SPINNER_DISPLAY_NONE
SPINNER_DISPLAY_NUMERIC
SPINNER_DISPLAY_SYMBOL

Example:

Application.spinnerDisplay = Application.SPINNER_DISPLAY_SYMBOL

Export Type

EXPORT_DIAGRAM_PDF
EXPORT_DIAGRAM_JPEG
EXPORT_DIAGRAM_PNG
EXPORT_DIAGRAM_DOT
EXPORT_ANNOTATIONS_PDF
EXPORT_ANNOTATIONS_TEXT
EXPORT_OUTLINE_OPML
EXPORT_DIAGRAM_PROJECT_XML
EXPORT_DIAGRAM_PROJECT_MPX
EXPORT_DIAGRAM_XSLT

Example:

document.exportDocument( Application.EXPORT_DIAGRAM_PDF, None, () )

Import Type

IMPORT_DIAGRAM_CSV
IMPORT_DIAGRAM_XSLT
IMPORT_DIAGRAM_PROJECT

Example:

document.importDocument( IMPORT_DIAGRAM_CSV,None, () )

Image Export Type

IMAGE_EXPORT_WIDTH
IMAGE_EXPORT_HEIGHT
IMAGE_EXPORT_RESOLUTION
IMAGE_EXPORT_SHOW_SELECTION
IMAGE_EXPORT_SAVE_INK
IMAGE_EXPORT_EMBED_FONTS

These types are used as keys in a dictionary, the value being the setting for the key. If a type appears in the dictionary, it overrides the current setting.

Example:

params = ( Application.IMAGE_EXPORT_SHOW_SELECTION : False )
document.exportDocument(Application.EXPORT_DIAGRAM_JPEG, params)

Weekday Type

SUNDAY_MASK
MONDAY_MASK
TUESDAY_MASK
WEDNESDAY_MASK
THURSDAY_MASK
FRIDAY_MASK
SATURDAY_MASK
DEFAULT_WORKDAYS

These are the same constants found in the Workweek class and duplicated here for convenience. See Workweek class for details.

OPML Export Type

OPML_EXPORT_FORWARD
OPML_EXPORT_UNICODE
OPML_EXPORT_INCLUDE_EQUATION

These types are used as keys in a dictionary, the value being the setting for the key. If a type appears in the dictionary, it overrides the current setting.

Example:

params = ( Application.EXPORT_OUTLINE_OPML: False )
document.exportDocument(Application.EXPORT_DIAGRAM_JPEG, params)

MS Project Export Type

MSPROJECT_EXPORT_ROUNDTRIP_LOW_CUSTOM_FIELDS						MSPROJECT_EXPORT_ROUNDTRIP_HIGH_CUSTOM_FIELDS
MSPROJECT_EXPORT_ROUNDTRIP_HIGH_CUSTOM_FIELDS

CSV Import Type

CSV_ENCODING
CSV_SEPARATOR
CSV_HEADER_ROW
CSV_TITLE_COLUMN
CSV_CLASS_COLUMN
CSV_ANNOTATION_COLUMN
CSV_CONNECTIONS_COLUMN
CSV_CONNECTIONS_TYPE
CSV_CHILDREN_COLUMN
CSV_INTERNAL_SEPARATOR
CSV_ROW_INDEX

CSV Import Encoding Value

CSV_ENCODING_ISO_8859_1
CSV_ENCODING_UTF8
CSV_ENCODING_ASCII

CSV Import Separator Value

CSV_SEPARATOR_COMMAS
CSV_SEPARATOR_TABS
CSV_SEPARATOR_SEMICOLONS

CSV Import Connection Value

CSV_PREDESSORS
CSV_SUCCESSORS

CSV Import Row Index Values

May also be an integer.

CSV_ROWS_ONE_BASIS 
CSV_ROWS_ZERO_BASIS

XSLT Import-Export Type

XSLT_ASK
XSLT_FILE
XSLT_STRING
XSLT_INCLUDE_FRAMES
XSLT_INCLUDE_EDGE_SPLINES

These types are used as keys in a dictionary, the value being the setting for the key.

The first three values are mutually exclusive and indicate the source of the XSLT file: either ask the user for locate the file (value should be True), use the given file (the value is the path to the file as a string), or use the already loaded/embedded string (XLST file as a string).

The last two are only used when exporting, and indicate whether the Flying Logic document to be transformed should include graph element frames and edge splines.

Example:

params = (
  Application.XSLT_ASK : True,
  Application.XSLT_INCLUDE_FRAMES : True
)
document.exportDocument(Application.EXPORT_DIAGRAM_XSLT, params)

Find Type

FIND_CASE_SENSITIVE
FIND_WHOLE_WORDS_ONLY
FIND_SEARCH_TITLES # API 1.14
FIND_SEARCH_LABELS # Deprecated, same as FIND_SEARCH_TITLES
FIND_SEARCH_ANNOTATIONS
FIND_SEARCH_UDA_NAMES
FIND_SEARCH_UDA_VALUES
FIND_SEARCH_RESOURCES
FIND_SELECT_COLLAPSED_GROUPS

These types are used as keys in a dictionary, the value being the setting for the key. If a type appears in the dictionary, it overrides the current setting.

Example:

params = ( Application.FIND_SEARCH_ANNOTATIONS:True )
document.find(โ€˜communicateโ€™, params)

Operate Type

OPERATE_ENTITY
OPERATE_JUNCTOR
OPERATE_EDGE
OPERATE_REVERSE
OPERATE_NON_EDGE
OPERATE_ALL

The first four types above are bit fields. The first three limit which graph element types are operated upon, while OPERATE_REVERSE indicated the elements should be iterated through end to start. OPERATE_NON_EDGE is the same as OPERATE_ENTITY | OPERATE_JUNCTOR, and OPERATE_ALL should be obvious.

Example:

mask = Application.OPERATE_ENTITY | Application.OPERATE_REVERSE
document.operate(myGraphOperator, mask)

Symbol Name Type

BITMAP_PREFIX
SVG_PREFIX
SYMBOL_SEPARATOR

BITMAP_PREFIX and SVG_PREFIX are the generator names for bitmap images and SVG drawing custom symbols. SYMBOL_SEPARATOR is the a colon.

See Graphic Symbol Names for a list of the built-in symbol name constants.

Special Symbol Type

INHERIT_SYMBOL
NO_SYMBOL

Special predefined Symbol instances. INHERIT_SYMBOL will set an entityโ€™s symbol back to the default for its entity class. NO_SYMBOL will set an entityโ€™s symbol to none, overriding any possible default symbol for its entity class. For groups both INHERIT_SYMBOL and NO_SYMBOL clear the group symbol.

Text Editor Type

BOLD
ITALIC
UNDERLINED
STRIKETHROUGH
LINK
FONT_SIZE
FONT_FAMILY
FONT_COLOR

These types are used as keys in a dictionary, the value being the attribute for the key.

Example:

editor.changeSelectionAttributes( ( Application.BOLD: True ) )

Edge Part Type

EDGE_HEAD
EDGE_TAIL

Which end of an edge to reconnect.

Example:

document.reconnect( edge, Application.EDGE_TAIL, entity )

Shape Part Type

PART_WEIGHT
PART_ANNOTATION
PART_HOIST_CAP
PART_CONFIDENCE
PART_COMPLETION
PART_ENTITYID
PART_TITLE
PART_CLASS
PART_CLASS_BKGD
PART_START_DATE
PART_FINISH_DATE
PART_RESOURCES
PART_DISCLOSURE
PART_SYMBOL
PART_ANNOTATION_NUMBER
PART_ANNOTATION_TEXT
PART_COMPLETION_BAR
PART_EDGE_INFO

Parts of an element's shape.

Chart Part Type

PART_CHART_ROW
PART_CHART_INDEX
PART_CHART_ANNOTATION
PART_CHART_DISCLOSURE
PART_CHART_SYMBOL
PART_CHART_TITLE
PART_CHART_CLASS
PART_CHART_CLASS_COLOR
PART_CHART_CONFIDENCE
PART_CHART_ENTITYID
PART_CHART_START_DATE
PART_CHART_FINISH_DATE
PART_CHART_COMPLETION
PART_CHART_RESOURCES
PART_CHART_EFFORT

Parts of the chart table.

Other Font Type

AUTOSIZE

A special โ€œfont sizeโ€ that means โ€œset the size as the application sees fit.โ€

Example:

document.titleFontSize = Application.AUTOSIZE

File Type

FILE_SEPARATOR
DOCUMENT_EXTENSION
TEMPLATE_EXTENSION
DOMAIN_EXTENSION

These are various file-lated constants: the system-dependent file path separator, the Flying Logic document file extension, the Flying Logic template file extension, and the Flying Logic domain file extension.

Schedule Type

SCHEDULE_FROM_START_DATE
SCHEDULE_FROM_FINISH_DATE

Direction that project should be scheduled.

Open Document Option Type

OPEN_DOCUMENT_IN_WINDOW
OPEN_DOCUMENT_IN_TAB
OPEN_DOCUMENT_ASK

Valid values for the openDocumentOption preference.

Canvas View Type

GRAPH_VIEW
CHART_VIEW

Canvas view kinds.

Resource Assignment Type

RESOURCE_FIXED_EFFORT
RESOURCE_FIXED_DURATION
RESOURCE_FIXED_UNITS
RESOURCE_FIXED_WORK

If two or more resources are assigned to a task, this value determines how those resources are applied. With RESOURCE_FIXED_EFFORT the effort is considered total work hours to be distributed between resources. With RESOURCE_FIXED_DURATION, the effort acts as a fixed duration and resources all work that number of hours on the task. Finally, RESOURCE_FIXED_UNITS results in each resource only working part-time on the task.

Edge Spline Type

PART_HEAD
PART_MIDDLE
PART_TAIL

Types that appear in a spline dictionary.

Diagram Import Type

DIAGRAM_IMPORT_NEW_DOCUMENT
DIAGRAM_IMPORT_PM_DOMAIN
DIAGRAM_INCLUDE_TOP_GROUP

These types are used as keys in a dictionary, the value being the setting for the key. If a type appears in the dictionary, it overrides the current setting. All the current settings are booleans.

Static Font Type

FONT_SPINNER_LARGE
FONT_SPINNER_SMALL
FONT_SPINNER_UNDEFINED
FONT_ANNOTATION_ICON
FONT_ANNOTATION_NUMBER
FONT_DATE
FONT_DATE_BOLD
FONT_ROW
FONT_ROW_BOLD
FONT_CAP_ENTITY_ID
FONT_JUNCTOR_LARGE
FONT_JUNCTOR_SMALL
FONT_JUNCTOR_CHART
FONT_CHART_CALENDAR

Symbolic names of various fonts used to display shapes. Used in Documentโ€™s findStaticFont method.

Symbol Scale and Size Type

GRAPH_SYMBOL_SCALE
CHART_SYMBOL_SCALE

Scale factors when calling the generateSvg method of Symbol class.

CHART_SYMBOL_SIZE

Can be used as maxSize when calling the generateSvg method of the Symbol class for chart-like output. Graph-like output should set maxSize to None indicating an unconstrained size.

Last updated