Diagram Layout property set objects

Overview

This topic discusses the JSON Diagram Layout property set object as returned by the REST API for each diagram layout—AngleDirectedDiagramLayout, CompressionDiagramLayout, ForceDirectedDiagramLayout, GeoPositionsDiagramLayout, GridDiagramLayout, LinearDispatchDiagramLayout, MainLineTreeDiagramLayout, MainRingDiagramLayout, PartialOverlappingEdgesDiagramLayout, RadialTreeDiagramLayout, ReshapeEdgesDiagramLayout, RotateTreeDiagramLayout, SeparateOverlappingEdgesDiagramLayout, SmartTreeDiagramLayout, and SpatialDispatchDiagramLayout.

Note:

The is_active property explained in the layout property set objects below has no interest for layout parameters that don't apply to a template. When a layout is executed using the applyLayout operation and the is_active property is specified among the properties of the input layoutParameters parameter, this property will be simply ignored.

AngleDirectedDiagramLayout property set object

The AngleDirectedDiagramLayout property set object provides the following information:

  • are_containers_preserved—Whether the layout preserve the containers in the diagram or not (Boolean).
  • is_active—Whether the layout is active or not. (see Note)
  • iterations_number—The number of layout algorithm iterations to process (Long).
  • number_of_directions— The number of directions that must be used to align the diagram edges and their connected junctions (Enum):
    • 4 for FOUR_DIRECTIONS
    • 8 for EIGHT_DIRECTIONS
    • 12 for TWELVE_DIRECTIONS
Note:

This layout and its parameters are more detailed in the Apply Angle Directed Layout tool topic.

JSON Syntax

AngleDirectedDiagramLayout property set syntax

{
  "type": "PropertySet",
  "propertySetItems": ["are_containers_preserved", <true | false>, "is_active", <true | false>, "iterations_number", <iterations_number>, "number_of_directions", <4 | 8 |12>]
}

JSON Example

AngleDirectedDiagramLayout property set sample

{
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "iterations_number",
    1,
    "number_of_directions",
    8
   ]
  }

CompressionDiagramLayout property set object

The CompressionDiagramLayout property set object provides the following information:

  • are_containers_preserved—Whether the layout preserve the containers in the diagram or not (Boolean).
  • is_active—Whether the layout is active or not. (see Note)
  • grouping_distance—Distance which is used to determine whether two connected junctions must be considered as part of the same "junctions group" or not in the diagram coordinate system (Double).
  • vertices_removal_rule—Determines how vertices along edges in the diagram must be processed (Enum).
    • 1 for REMOVE_ALL,
    • 2 for KEEP_INSIDE_VERTICES,
    • 3 for KEEP_FIRST_VERTEX_OUTSIDE_AND_INSIDE_VERTICES
Note:

This layout and its parameters are more detailed in the Apply Compression Layout tool topic.

JSON Syntax

CompressionDiagramLayout property set syntax

{
  "type": "PropertySet",
  "propertySetItems": ["are_containers_preserved", <true | false>, "is_active", <true | false>, "grouping_distance", <grouping_distance>, "vertices_removal_rule", <1 | 2 | 3>]
}

JSON Example

CompressionDiagramLayout property set example

{
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    true,
    "is_active",
    false,
    "grouping_distance",
    20,
    "vertices_removal_rule",
    2
   ]
  }

ForceDirectedDiagramLayout property set object

The ForceDirectedDiagramLayout property set object provides the following information:

  • are_containers_preserved—Whether the layout preserve the containers in the diagram or not (Boolean).
  • is_active—Whether the layout is active or not. (see Note)
  • iterations_number—The number of layout algorithm iterations to process (Long).
  • repel_factor—Factor used to quickly increase diagram junctions displacement for junctions that are close together (Long)
  • degree_freedom—Factor that limits the area used to move the diagram junctions during each algorithm iteration (Enum).
    • 1 for LOW,
    • 2 for MEDIUM,
    • 3 for HIGH.
  • edge_display_type—The type of display for the diagram edges (Enum).
    • 0 for REGULAR_EDGES,
    • 2 for CURVED_EDGES.
  • breakpoint_position—A double between 0.15 and 0.40 which determines the relative position of the two inflexion points that will be inserted along the diagram edges to compute the curved edges geometry when edge_display_type=1 (Double). This parameter is ignored when edge_display_type=0.
Note:

This layout and its parameters are more detailed in the Apply Force Directed Layout tool topic.

JSON Syntax

ForceDirectedDiagramLayout property set syntax

{
  "type": "PropertySet",
  "propertySetItems": ["are_containers_preserved", <true | false>, "is_active", <true | false>, "iterations_number", <NumberOfIterations>, "repel_factor", <RepelFactor>, "degree_freedom", <1 | 2 | 3>, "edge_display_type", <0 | 1 >, "breakpoint_position", <breakpointPosition>]
}

JSON Example

ForceDirectedDiagramLayout property set example

{
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "iterations_number",
    20,
    "repel_factor",
    1,
    "degree_freedom",
    1,
    "edge_display_type",
    0,
    "breakpoint_position",
    0.29999999999999999
   ]
  }

GeoPositionsDiagramLayout property set object

The GeoPositionsDiagramLayout property set object provides the following information:

  • is_active—Whether the layout is active or not. (see Note)
  • restore_edges_geo_positions—Whether the layout algorithm will process diagram edges and try to restore geographic vertices along them or not (Boolean).
Note:

This layout and its parameters are more detailed in the Apply Geo Positions Layout tool topic.

JSON Syntax

GeoPositionsDiagramLayout property set syntax

{
   "type": "PropertySet",
   "propertySetItems": [
    "is_active",
    false,
    "restore_edges_geo_positions",
    true
   ]
  }

JSON Example

GeoPositionsDiagramLayout property set example

{
   "type": "PropertySet",
   "propertySetItems": [
    "is_active",
    false,
    "restore_edges_geo_positions",
    true
   ]
  }

GridDiagramLayout property set object

The GridDiagramLayout property set object provides the following information:

  • are_containers_preserved—Whether the layout preserve the containers in the diagram or not (Boolean).
  • is_active—Whether the layout is active or not. (see Note)
  • cell_width—The width of each grid cell in the diagram coordinates system (Double).
  • cell_height—The height of each grid cell in the diagram coordinates system (Double).

Note:

This layout and its parameters are more detailed in the Apply Grid Layout tool topic.

JSON Syntax

GridDiagramLayout property set syntax

{
  "type": "PropertySet",
  "propertySetItems": ["are_containers_preserved", < true | false >, "is_active", <true | false>, "cell_width", <cell_width>, "cell_height", <cell_height>]
}

JSON Example

GridDiagramLayout property set example

{
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "cell_width",
    2,
    "cell_height",
    2
   ]
  }

LinearDispatchDiagramLayout property set object

The LinearDispatchDiagramLayout property set object provides the following information:

  • is_unit_absolute—Whether the layout parameters representing distances must be interpreted as linear units in the diagram coordinates system—True, or as relative units to an estimation of the average of the junctions sizes in the diagram when it is generated—False (Boolean).
  • is_active—Whether the layout is active or not. (see Note)
  • junction_placement_type—The way the layout algorithm will move the diagram junctions (Enum):
    • 1 for EQUAL_DISTANCE,
    • 2 for USER_DEFINE_DISTANCE,
    • 3 for ITERATIVE_DISTANCE.
  • maximum_shift—Parameter expected when junction_placement_type = 3 that specifies the maximum distance the junctions with two connections can be spaced from the junctions to which they connect (Double).
  • minimum_shift—Parameter expected when junction_placement_type = 2 that determines the minimum distance that will separate each junction with two connected edges from its two edges extremities after the layout execution (Double).
  • iterations_number—The number of layout algorithm iterations to process (Long).
  • is_path_preserved— Whether the layout algorithm will preserve the vertices along edges when executing or not (Boolean).
  • are_leaves_moved—Whether the leaf junctions; that is, the junctions with one connection, can be moved or not during the algorithm execution (Boolean).
  • are_leaves_expanded—Whether the leaf junctions; that is, the junctions with one connection, can be expanded or not during the algorithm execution (Boolean).
  • expand_shift—Parameter expected when are_leaves_expanded = true that specifies the maximum distance the leaf junctions can be expanded(Double).

Note:

This layout and its parameters are more detailed in the Apply Linear Dispatch Layout tool topic.

JSON Syntax

LinearDispatchDiagramLayout property set syntax

{
  "type": "PropertySet",
  "propertySetItems": ["is_unit_absolute", < true | false >, "is_active", <true | false>, "junction_placement_type", < 1 | 2 | 3 >, "maximum_shift", <maximum_shift>, "minimum_shift", <minimum_shift>, "iterations_number", <iterations_number>, "is_path_preserved", < true | false >, "are_leaves_moved", < true | false >, "are_leaves_expanded", < true | false >, "expand_shift", <expand_shift>]
}

JSON Example

LinearDispatchDiagramLayout property set example

{
   "type": "PropertySet",
   "propertySetItems": [
    "is_unit_absolute",
    false,
    "is_active",
    false,
    "junction_placement_type",
    1,
    "maximum_shift",
    2,
    "minimum_shift",
    2,
    "iterations_number",
    5,
    "is_path_preserved",
    true,
    "are_leaves_moved",
    false,
    "are_leaves_expanded",
    false,
    "expand_shift",
    2
   ]
  }

MainLineTreeDiagramLayout property set object

The MainLineTreeDiagramLayout property set object provides the following information:

  • are_containers_preserved—Whether the layout preserve the containers in the diagram or not (Boolean).
  • is_active—Whether the layout is active or not. (see Note)
  • is_unit_absolute—Whether the layout parameters representing distances must be interpreted as linear units in the diagram coordinates system—True, or as relative units to an estimation of the average of the junctions sizes in the diagram when it is generated—False (Boolean).
  • tree_direction—The direction of the tree (Enum):
    • 0 for FROM_RIGHT_TO_LEFT,
    • 1 for FROM_TOP_TO_BOTTOM,
    • 2 for FROM_LEFT_TO_RIGHT,
    • 3 fpr FROM_BOTTOM_TO_TOP.
  • branches_placement—The way the branches which start from the mainline are placed (Enum):
    • 0 for LEFT_SIDE_OF_MAIN_LINE,
    • 1 for RIGHT_SIDE_OF_MAIN_LINE,
    • 2 for BOTH_SIDES_OF_MAIN_LINE.
  • perpendicular—Specifies the spacing between diagram junctions that are displayed along the axis perpendicular to the mainline in the diagram coordinate system when is_unit_absolute = True or in proportional units is_unit_absolute = False (Double).
  • along—Specifies the spacing between diagram junctions that are displayed along the mainline and diagram junctions that are displayed along the axis parallel to this mainline in the diagram coordinate system when is_unit_absolute = True or in proportional units is_unit_absolute = False (Double).
  • disjoined_graph—Specifies the minimum spacing that must separate features belonging to disjoined graphs when the diagram contains such graphs in the diagram coordinate system when Absolute = True or in proportional units is_unit_absolute = False (Double).
  • are_edges_orthogonal—Whether the diagram edges related to the tree branches will display with right angle or not (Boolean).
    Note:

    This parameter is deprecated at ArcGIS Server 10.6. It is systematically ignored regardless of its value when the edge_display_type parameter is specified.

  • breakpoint_position—A double between 0 and 1 which determines the relative position of the break point on the diagram edges when edge_display_type=0 or edge_display_type=1. A double between 0.15 and 0.40 which determines the relative position of the two inflexion points that will be inserted along the diagram edges to compute the curved edges geometry when edge_display_type=2.
  • edge_display_type—The type of display for the diagram edges (Enum).
    • 0 for REGULAR_EDGES,
    • 1 for ORTHOGONAL_EDGES,
    • 2 for CURVED_EDGES

Note:

This layout and its parameters are more detailed in the Apply Mainline Tree Layout tool topic.

JSON Syntax

MainLineTreeDiagramLayout property set syntax

{
  "type": "PropertySet",
  "propertySetItems": ["are_container_preserved", < true | false >, "is_active", <true | false>, "is_unit_absolute", < true | false >, "tree_direction", < 0 | 1 | 2 | 3>,  "branches_placement", < 0 | 1 | 2 >, "perpendicular", <perpendicular>, "along", <along>, "disjoined_graph", <disjoined_graph>, "are_edges_orthogonal", < true | false >, "breakpoint_position", <breakpoint_position>, "edge_display_type", < 0 | 1 | 2 >]
}

JSON Example

MainLineTreeDiagramLayout property set example

{
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "is_unit_absolute",
    false,
    "tree_direction",
    2,
    "branches_placement",
    2,
    "perpendicular",
    2,
    "along",
    2,
    "disjoined_graph",
    4,
    "are_edges_orthogonal",
    false,
    "breakpoint_position",
    0.29999999999999999,
    "edge_display_type",
    0
   ]
  }

MainRingDiagramLayout property set object

The MainRingDiagramLayout property set object provides the following information:

  • are_containers_preserved—Whether the layout preserve the containers in the diagram or not (Boolean).
  • is_active—Whether the layout is active or not. (see Note)
  • is_unit_absolute—Whether the layout parameters representing distances must be interpreted as linear units in the diagram coordinates system—True, or as relative units to an estimation of the average of the junctions sizes in the diagram when it is generated—False (Boolean).
  • ring_type—The type of ring (Enum):
    • 0 for RECTANGLE,
    • 1 for ELLIPSE.
  • tree_type—The way the trees coming out of the main ring's junctions will be positioned (Enum):
    • 0 for LEFT_SIDE,
    • 1 for RIGHT_SIDE,
    • 2 for BOTH_SIDES,
    • 3 for COMPACT_TREE (Value ignored at the moment. It will be interpreted as 4.),
    • 4 for SMART_TREE.
  • edge_display_type—The type of display for the trees' diagram edges (Enum).
    • 0 for REGULAR_EDGES,
    • 1 for ORTHOGONAL_EDGES,
    • 2 for CURVED_EDGES
  • ring_width—Specifies the width of the ring in the diagram coordinate system when is_unit_absolute = True or in proportional units is_unit_absolute = False (Double).
  • ring_height—Specifies the height of the ring in the diagram coordinate system when is_unit_absolute = True or in proportional units is_unit_absolute = False (Double).
  • perpendicular—Specifies the spacing between diagram junctions that are displayed along the axis perpendicular to the tree direction in the diagram coordinate system when is_unit_absolute = True or in proportional units is_unit_absolute = False (Double).
  • along—Specifies the spacing between diagram junctions that are displayed along the tree direction in the diagram coordinate system when is_unit_absolute = True or in proportional units is_unit_absolute = False (Double).
  • breakpoint_position—A double between 0 and 1 which determines the relative position of the break point on the diagram edges when edge_display_type=0 or edge_display_type=1. A double between 0.15 and 0.40 which determines the relative position of the two inflexion points that will be inserted along the diagram edges to compute the curved edges geometry when edge_display_type=2

Note:

This layout and its parameters are more detailed in the Apply Main Ring Layout tool topic.

JSON Syntax

MainRingDiagramLayout property set syntax

{
   "type": "PropertySet",
   "propertySetItems": ["are_containers_preserved", <true | false>, "is_active", <true | false>, "is_unit_absolute", <true | false>,
    "ring_type",<1 | 2>, "tree_type", <1 |2 |3 |4>, "edge_display_type", <0 |1 |2 >, "ring_width", <RingWidth>,
    "ring_height", <RingHeight>, "perpendicular", <perpendicular>, "along", <along>, "breakpoint_position", <breakPoint>]
  }

JSON Example

MainRingDiagramLayout property set example

{
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "is_unit_absolute",
    false,
    "ring_type",
    1,
    "tree_type",
    4,
    "edge_display_type",
    0,
    "ring_width",
    50,
    "ring_height",
    20,
    "perpendicular",
    2,
    "along",
    2,
    "breakpoint_position",
    0.29999999999999999
   ]
  }

PartialOverlappingEdgesDiagramLayout property set object

The PartialOverlappingEdgesDiagramLayout property set object provides the following information:

  • is_active—Whether the layout is active or not. (see Note)
  • buffer_width— Specifies the width of the buffer zones inside which you want the algorithm to search for collinear edge segments in the diagram coordinates system (Double).
  • offset—Specifies the distance that will separate the detected edge segments after layout algorithm execution in the diagram coordinates system (Double).
  • optimize_edges—Whether the layout algorithm will try to optimize the segment placement order in each set of detected collinear segments to try to avoid crossing or not (Boolean).

Note:

This layout and its parameters are more detailed in the Apply Partial Overlapping Edges Layout tool topic.

JSON Syntax

PartialOverlappingEdgesDiagramLayout property set syntax

{
  "type": "PropertySet",
  "propertySetItems": ["is_active", <true | false>, "buffer_width", <buffer_width>, "offset", <offset>, "optimize_edges", < true | false >]
}

JSON Example

PartialOverlappingEdgesDiagramLayout property set example

{
   "type": "PropertySet",
   "propertySetItems": [
    "is_active",
    false,
    "buffer_width",
    1,
    "offset",
    0.5,
    "optimize_edges",
    false
   ]
  }

RadialTreeDiagramLayout property set object

The RadialTreeDiagramLayout property set object provides the following information:

  • are_containers_preserved—Whether the layout preserve the containers in the diagram or not (Boolean).
  • is_active—Whether the layout is active or not. (see Note)
  • is_unit_absolute—Whether the layout parameters representing distances must be interpreted as linear units in the diagram coordinates system—True, or as relative units to an estimation of the average of the junctions sizes in the diagram when it is generated—False (Boolean).
  • initial_radius—Represents the radius of the first concentric circle whose center is the radial tree root junction in the diagram coordinate system when is_unit_absolute = True or in proportional units is_unit_absolute = False (Double).
  • disjoined_graph—Specifies the minimum spacing that must separate features belonging to disjoined graphs when the diagram content such graphs in the diagram coordinate system when is_unit_absolute = True or in proportional units is_unit_absolute = False (Double).
  • radius_factor —Represents the multiplicative factor used to increase or decrease the radius of each concentric circle (Double).

Note:

This layout and its parameters are more detailed in the Apply Radial Tree Layout tool topic.

JSON Syntax

RadialTreeDiagramLayout property set syntax

{
  "type": "PropertySet",
  "propertySetItems": ["are_containers_preserved", < true | false >, "is_active", <true | false>, "is_unit_absolute", < true | false >, "initial_radius", <initial_radius>, "disjoined_graph", <disjoined_graph>, "radius_factor", <radius_factor>]
}

JSON Example

RadialTreeDiagramLayout property set example

{
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "is_unit_absolute",
    false,
    "initial_radius",
    5,
    "disjoined_graph",
    10,
    "radius_factor",
    1
   ]
  }

ReshapeEdgesDiagramLayout property set object

The ReshapeEdgesDiagramLayout property set object provides the following information:

  • are_containers_preserved—Whether the layout preserve the containers in the diagram or not (Boolean).
  • is_active—Whether the layout is active or not. (see Note)
  • reshape_type— The type of reshape operation the algorithm will process:
    • 0 for SQUARE_EDGES,
    • 1 for REMOVE_VERTICES,
    • 2 for SEPARATE_OVERLAPPING_EDGES,
    • 3 for REDUCE_VERTICES_BY_ANGLE.
  • is_path_preserved—When executing with reshape_type=0, whether the layout algorithm will preserve the vertices along edges when executing or not (Boolean).
  • angle_threshold—When executing with reshape_type=3, specifies the angle formed by the incident segments over which the vertex related to these segments is reduced (Double).
  • shift_between_edge—When executing with reshape_type=2, specifies the spacing that will separate two edges that have been just processed by the layout algorithm, in the diagram coordinate system (Double).
  • offset_between_segment—When executing with ReshapeType=0, specifies the spacing that will separate parallel segments of edges incident to a same junction when those edges are squared, distance being interpreted in the diagram coordinate system (Double).
  • breakpoint—When executing with reshape_type=0, specifies the maximum distance between each junction to the 1st or last break point along edges incident to that junction when those edges are squared, distance being interpreted in the diagram coordinate system (Double).

Note:

This layout and its parameters are more detailed in the Reshape Diagram Edges Layout tool topic.

JSON Syntax

{
  "type": "PropertySet",
  "propertySetItems": ["are_containers_preserved", < true | false >, "is_active", <true | false>, "reshape_type", < 1 | 2 | 3 | 4 >, "is_path_preserved", < true | false >, "angle_threshold", <angle_threshold>, "shift_between_edge", <shift_between_edge>, "offset_between_segment", <offset_between_segment>, "breakpoint", <breakpoint>]
}

JSON Example

{
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "reshape_type",
    1,
    "is_path_preserved",
    true,
    "angle_threshold",
    0,
    "shift_between_edge",
    0.5,
    "offset_between_segment",
    5,
    "breakpoint",
    8.6600000000000001
   ]
  }

RotateTreeDiagramLayout property set object

The RotateTreeDiagramLayout property set object provides the following information:

  • are_containers_preserved—Whether the layout preserve the containers in the diagram or not (Boolean).
  • angle —Represents the angle in degrees that will be used to rotate the tree (Double).

Note:

This layout and its parameters are more detailed in the Apply Rotate Tree Layout tool topic.

JSON Syntax

RotateTreeDiagramLayout property set syntax

{
  "type": "PropertySet",
  "propertySetItems": ["are_containers_preserved", < true | false >, "is_active", <true | false>, "rotation_angle", <rotation_angle>]
}

JSON Example

RotateTreeDiagramLayout property set example

{
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "rotation_angle",
    45
   ]
  }

SmartTreeDiagramLayout property set object

The SmartTreeDiagramLayout property set object provides the following information:

  • are_containers_preserved—Whether the layout preserve the containers in the diagram or not (Boolean).
  • is_active—Whether the layout is active or not. (see Note)
  • is_unit_absolute—Whether the layout parameters representing distances must be interpreted as linear units in the diagram coordinates system—True, or as relative units to an estimation of the average of the junctions sizes in the diagram when it is generated—False (Boolean).
  • tree_direction—The direction of the tree (Enum):
    • 0 for FROM_RIGHT_TO_LEFT,
    • 1 for FROM_TOP_TO_BOTTOM,
    • 2 for FROM_LEFT_TO_RIGHT,
    • 3 for FROM_BOTTOM_TO_TOP.
  • subtree—Determines the spacing between two neighboring subtrees in the diagram coordinate system when is_unit_absolute = True or in proportional units is_unit_absolute = False (Double).
  • perpendicular —Specifies the spacing between diagram junctions that are displayed perpendicularly to the smart tree direction and that belong to the same subtree level in the diagram coordinate system when is_unit_absolute = True or in proportional units is_unit_absolute = False (Double).
  • along—Specifies the spacing between diagram junctions that are displayed along the smart tree direction in the diagram coordinate system when is_unit_absolute = True or in proportional units is_unit_absolute = False (Double).
  • disjoined_graph—Specifies the minimum spacing that must separate features belonging to disjoined graphs when the diagram contains such graphs in the diagram coordinate system when is_unit_absolute = True or in proportional units is_unit_absolute = False (Double).
  • are_edges_orthogonal—Whether the diagram edges related to the tree branches will display with right angle or not (Boolean).
    Note:

    This parameter is deprecated at ArcGIS Server 10.6. It is systematically ignored regardless of its value when the edge_display_type parameter is specified.

  • breakpoint_position—A double between 0 and 1 which determines the relative position of the break point on the diagram edges when edge_display_type=0 or edge_display_type=1. A double between 0.15 and 0.40 which determines the relative position of the two inflexion points that will be inserted along the diagram edges to compute the curved edges geometry when edge_display_type=2
  • edge_display_type—The type of display for the diagram edges (Enum).
    • 0 for REGULAR_EDGES,
    • 1 for ORTHOGONAL_EDGES,
    • 2 for CURVED_EDGES

Note:

This layout and its parameters are more detailed in the Apply Smart Tree Layout tool topic.

JSON Syntax

SmartTreeDiagramLayout property set syntax

{
  "type": "PropertySet",
  "propertySetItems": ["are_containers_preserved", < true | false >, "is_active", <true | false>, "is_unit_absolute", < true | false >, "tree_direction", <0 |1 | 2 | 3>, "subtree", <subtree>, "perpendicular", <perpendicular>, "along", <along>, "disjoined_graph", <disjoined_graph>, "are_edges_orthogonal", < true | false >, "breakpoint_position", <breakpoint_position>, "edge_display_type", < 0 | 1 | 2 >]
}

JSON Example

SmartTreeDiagramLayout property set example

{
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "is_unit_absolute",
    false,
    "tree_direction",
    2,
    "subtree",
    2,
    "perpendicular",
    2,
    "along",
    2,
    "disjoined_graph",
    4,
    "are_edges_orthogonal",
    false,
    "breakpoint_position",
    0.29999999999999999,
    "edge_display_type",
    0
   ]
  }

SpatialDispatchDiagramLayout property set object

The SpatialDispatchDiagramLayout property set object provides the following information:

  • are_containers_preserved—Whether the layout preserve the containers in the diagram or not (Boolean).
  • is_active—Whether the layout is active or not. (see Note)
  • iterations_number—The number of layout algorithm iterations to process (Long).
  • maximum_shift_factor— Specifies the intensity of the diagram junctions' displacement for junctions that are very close together. The larger the shift factor, the larger the separation between the diagram junctions that almost overlap. (Long)

Note:

This layout and its parameters are more detailed in the Apply Spatial Dispatch Layout tool topic.

JSON Syntax

SpatialDispatchDiagramLayout property set syntax

{
  "type": "PropertySet",
  "propertySetItems": ["are_containers_preserved", < true | false >, "is_active", <true | false>, "iterations_number", <iterations_number>, "maximum_shift_factor", <maximum_shift_factor>]
}

JSON Example

SpatialDispatchDiagramLayout property set example

{
   "type": "PropertySet",
   "propertySetItems": [
    "are_containers_preserved",
    false,
    "is_active",
    false,
    "iterations_number",
    5,
    "maximum_shift_factor",
    2
   ]
  }