Effector 6.3 developer manual

XML reference 6.3

Effector Studio 6.3 summary

Effector Studio 6.3 manual

Effector 6.2 developer manual

XML reference 6.0

Effector Studio 3.2 summary

Effector Studio 3.2 manual

GraphDisplay

The GraphDisplay type basically serves to display Effector cards in a graph like manner. Unlike in other cases, the parametrization of this display needs two DataDefinitions for an easier description of the relationships among cards. One of the DataDefinitions defines the data needed for the display of the cards, while the other describes the connections.

/GraphDisplay

Root element.

/GraphDisplay/Caption (String)

The caption to be displayed. Optional, currently only used by the Effector Studio.

/GraphDisplay/Readonly (Boolean)

Serves to set if the graph can be edited (if the cards can be moved and the arrows reset). Optional. Default value is false.

/GraphDisplay/GridSize (Integer)

Size of the Snap-to-grid. Optional, its default value is 14.

/GraphDisplay/TemplateURL (String)

Its a node to display a custom display, where you can enter the URL of a custom display.

/GraphDisplay/ScaleSettings

Collection node containing the zoom settings. Optional.

/GraphDisplay/ScaleSettings/Min (Float)

The smallest allowed zooming size. Optional. The default value is 0.5.

/GraphDisplay/ScaleSettings/Max (Float)

The biggest allowed zooming size. Optional. The default value is 1.

/GraphDisplay/ScaleSettings/Step (Float)

The scale of zooming in or out. Optional. Default value is 0.08.

/GraphDisplay/ScaleSettings/Default (Float)

The scale of the initial zoom. Optional. The default value is 1.

/GraphDisplay/Element

Collection node containing the nodes of the properties of the cards.

/GraphDisplay/Element/DataDefinition (String)

The DataDefinition file that creates the set of results belonging to the cards.

/GraphDisplay/Element/IDColumn (String)

The name of the DataDefiniton column clearly identifying the card in the given DataDefiniton (primary key like).

/GraphDisplay/Element/WidthColumn (String)

The name of the DataDefiniton column specifying the width of the card.

/GraphDisplay/Element/HeightColumn (String)

The name of the DataDefiniton column specifying the height of the card.

/GraphDisplay/Element/TemplateURL (String)

The path of the Angular TemplateURL defining the card.

/GraphDisplay/Element/TitleColumn (String)

The name of the Tooltip containing DataDefinition column can be given here. The text in the column appears upon hovering the cursor on the card. Optional.

/GraphDisplay/Element/PositionXColumn (String)

The X coordinate of the display of the card. The card's top left corner will be located here. If no X nor Y coordinates are given, the cards appear automatically in the middle of the screen underneath each other. Optional.

/GraphDisplay/Element/PositionYColumn (String)

The Y coordinate of the display of the card. The card's top left corner will be located here. If no X nor Y coordinates are given, the cards appear automatically in the middle of the screen underneath each other. Optional.

/GraphDisplay/Element/DisplayTypeColumn (String)

The name of the DataDefinition column containing the cards' JavaScript type. The type is interpreted on the joint.shapes name field. Optional.

/GraphDisplay/Connection

The collection node containing the nodes describing the arrows that connect the cards.

/GraphDisplay/Connection/DataDefinition (String)

The DataDefiniton file describing the set of results that specify the arrows.

/GraphDisplay/Connection/SourceIDColumn (String)

The name of the column containing the identifier of the arrow's starting point in the DataDefiniton (the card identifier is in /GraphDisplay/Element/IDColumn).

/GraphDisplay/Connection/TargetIDColumn (String)

The name of the column containing the identifier of the arrow's ending point in the DataDefiniton (the card identifier is in /GraphDisplay/Element/IDColumn).

/GraphDisplay/Connection/LabelTextColumn (String)

The name of the DataDefinition column containing the label written on the arrow.

/GraphDisplay/Connection/LabelPositionColumn (String)

The name of the DataDefiniton column containing the position of the label written on the arrow. The value in the column must be a real number between 0 and 1 (including 0 and 1). Optional.

/GraphDisplay/Connection/DisplayTypeColumn (String)

The name of the DataDefinition column containing the JavaScript type of the arrow. The type is interpreted in the joint.shapes name field. Optional.

/GraphDisplay/ControlPanel

See: DisplayDefinition and Control types

/GraphDisplay/Links

See: DisplayDefinition and Control types

Example

Example

<?xml version="1.0" encoding="UTF-8"?> <GraphDisplay xmlns="http://effector.hu/schema/ns/GraphDisplay"> <Caption>GDRTGraphDisplay</Caption> <TemplateURL></TemplateURL> <Readonly>true</Readonly> <GridSize>14</GridSize> <Element> <DataDefinition>DataDefinition resource identifier</DataDefinition> <IDColumn>id column</IDColumn> <WidthColumn>width column</WidthColumn> <HeightColumn>height column</HeightColumn> <TemplateURL>HTML template path</TemplateURL> <TitleColumn>column title</TitleColumn> <PositionXColumn>column title</PositionXColumn> <PositionYColumn>column title</PositionYColumn> <DisplayTypeColumn>column title</DisplayTypeColumn> </Element> <Connection> <DataDefinition>DataDefinition resource identifier</DataDefinition> <SourceIDColumn>arrow`s beginning stranger key</SourceIDColumn> <TargetIDColumn>arrow`s end stranger key</TargetIDColumn> <DisplayTypeColumn>column title</DisplayTypeColumn> <LabelTextColumn>column title</LabelTextColumn> <LabelPositionColumn>column title</LabelPositionColumn> </Connection> <ScaleSettings> <Min>0.5</Min> <Max>1</Max> <Step>0.08</Step> <Default>1</Default> </ScaleSettings> <Links></Links> <ControlPanel></ControlPanel> </GraphDisplay>

  • Last update: 2 weeks 5 days ago
  • Effector