LayoutOptions

linnet_py Class

LayoutOptions(*, subgraph: _OptionalHedgeSelection = ..., viewport_width: _Number = ..., viewport_height: _Number = ..., tree_dx: _Number = ..., tree_dy: _Number = ..., steps: _Integer = ..., seed: _Integer = ..., step: _Number = ..., step_shrink: _Number = ..., cool: _Number = ..., accept_floor: _Number = ..., early_tolerance: _Number = ..., temperature: _Number = ..., delta: _Number = ..., beta: _Number = ..., spring_strength: _Number = ..., centering_strength: _Number = ..., epochs: _Integer = ..., crossing_penalty: _Number = ..., dangling_repulsion: _Number = ..., dangling_centroid_repulsion: _Number = ..., edge_edge_repulsion: _Number = ..., directional_force: _Number = ..., label_length_scale: _Number = ..., label_spring: _Number = ..., label_charge: _Number = ..., label_steps: _Integer = ..., label_layout: _LabelLayoutValue = ..., label_step: _Number = ..., label_early_tolerance: _Number = ..., label_max_delta_scale: _Number = ..., edge_vertex_repulsion: _Number = ..., epsilon: _Number = ..., incremental_energy: _Boolean = ..., algorithm: _LayoutAlgorithmValue = ..., nodes: _LayoutNodesValue = ..., direction: _LayoutDirectionValue = ..., rank_align: _RankAlignmentValue = ..., roots: _NodeIndices = ..., rank_same: _NodeGroups = ..., route_edge_weight: _Number = ..., route_exit_weight: _Number = ..., route_label_width_scale: _Number = ..., route_label_width_cap: _Number = ..., z_spring: _Number = ..., z_spring_growth: _Number = ..., length_scale: _Number = ...)

One or more ordered Linnest layout passes.

Constructor

Parameters

Name	Type	Default	Description
`subgraph`	`_OptionalHedgeSelection`	`runtime default`	—
`viewport_width`	`_Number`	`runtime default`	—
`viewport_height`	`_Number`	`runtime default`	—
`tree_dx`	`_Number`	`runtime default`	—
`tree_dy`	`_Number`	`runtime default`	—
`steps`	`_Integer`	`runtime default`	—
`seed`	`_Integer`	`runtime default`	—
`step`	`_Number`	`runtime default`	—
`step_shrink`	`_Number`	`runtime default`	—
`cool`	`_Number`	`runtime default`	—
`accept_floor`	`_Number`	`runtime default`	—
`early_tolerance`	`_Number`	`runtime default`	—
`temperature`	`_Number`	`runtime default`	—
`delta`	`_Number`	`runtime default`	—
`beta`	`_Number`	`runtime default`	—
`spring_strength`	`_Number`	`runtime default`	—
`centering_strength`	`_Number`	`runtime default`	—
`epochs`	`_Integer`	`runtime default`	—
`crossing_penalty`	`_Number`	`runtime default`	—
`dangling_repulsion`	`_Number`	`runtime default`	—
`dangling_centroid_repulsion`	`_Number`	`runtime default`	—
`edge_edge_repulsion`	`_Number`	`runtime default`	—
`directional_force`	`_Number`	`runtime default`	—
`label_length_scale`	`_Number`	`runtime default`	—
`label_spring`	`_Number`	`runtime default`	—
`label_charge`	`_Number`	`runtime default`	—
`label_steps`	`_Integer`	`runtime default`	—
`label_layout`	`_LabelLayoutValue`	`runtime default`	—
`label_step`	`_Number`	`runtime default`	—
`label_early_tolerance`	`_Number`	`runtime default`	—
`label_max_delta_scale`	`_Number`	`runtime default`	—
`edge_vertex_repulsion`	`_Number`	`runtime default`	—
`epsilon`	`_Number`	`runtime default`	—
`incremental_energy`	`_Boolean`	`runtime default`	—
`algorithm`	`_LayoutAlgorithmValue`	`runtime default`	—
`nodes`	`_LayoutNodesValue`	`runtime default`	—
`direction`	`_LayoutDirectionValue`	`runtime default`	—
`rank_align`	`_RankAlignmentValue`	`runtime default`	—
`roots`	`_NodeIndices`	`runtime default`	—
`rank_same`	`_NodeGroups`	`runtime default`	—
`route_edge_weight`	`_Number`	`runtime default`	—
`route_exit_weight`	`_Number`	`runtime default`	—
`route_label_width_scale`	`_Number`	`runtime default`	—
`route_label_width_cap`	`_Number`	`runtime default`	—
`z_spring`	`_Number`	`runtime default`	—
`z_spring_growth`	`_Number`	`runtime default`	—
`length_scale`	`_Number`	`runtime default`	—

Member details

`pass_count`

Property · read-only

pass_count: int

No description is available for this member.

`sequence`

Static method

sequence(passes: Sequence[LayoutOptions]) -> LayoutOptions

No description is available for this member.

Parameters

Name	Type	Default	Description
`passes`	`Sequence[LayoutOptions]`	`—`	—

`repr`

Method

__repr__() -> str

No description is available for this member.

`then`

Method

then(*, subgraph: _OptionalHedgeSelection = ..., viewport_width: _Number = ..., viewport_height: _Number = ..., tree_dx: _Number = ..., tree_dy: _Number = ..., steps: _Integer = ..., seed: _Integer = ..., step: _Number = ..., step_shrink: _Number = ..., cool: _Number = ..., accept_floor: _Number = ..., early_tolerance: _Number = ..., temperature: _Number = ..., delta: _Number = ..., beta: _Number = ..., spring_strength: _Number = ..., centering_strength: _Number = ..., epochs: _Integer = ..., crossing_penalty: _Number = ..., dangling_repulsion: _Number = ..., dangling_centroid_repulsion: _Number = ..., edge_edge_repulsion: _Number = ..., directional_force: _Number = ..., label_length_scale: _Number = ..., label_spring: _Number = ..., label_charge: _Number = ..., label_steps: _Integer = ..., label_layout: _LabelLayoutValue = ..., label_step: _Number = ..., label_early_tolerance: _Number = ..., label_max_delta_scale: _Number = ..., edge_vertex_repulsion: _Number = ..., epsilon: _Number = ..., incremental_energy: _Boolean = ..., algorithm: _LayoutAlgorithmValue = ..., nodes: _LayoutNodesValue = ..., direction: _LayoutDirectionValue = ..., rank_align: _RankAlignmentValue = ..., roots: _NodeIndices = ..., rank_same: _NodeGroups = ..., route_edge_weight: _Number = ..., route_exit_weight: _Number = ..., route_label_width_scale: _Number = ..., route_label_width_cap: _Number = ..., z_spring: _Number = ..., z_spring_growth: _Number = ..., length_scale: _Number = ...) -> LayoutOptions

No description is available for this member.

Parameters

Name	Type	Default	Description
`subgraph`	`_OptionalHedgeSelection`	`runtime default`	—
`viewport_width`	`_Number`	`runtime default`	—
`viewport_height`	`_Number`	`runtime default`	—
`tree_dx`	`_Number`	`runtime default`	—
`tree_dy`	`_Number`	`runtime default`	—
`steps`	`_Integer`	`runtime default`	—
`seed`	`_Integer`	`runtime default`	—
`step`	`_Number`	`runtime default`	—
`step_shrink`	`_Number`	`runtime default`	—
`cool`	`_Number`	`runtime default`	—
`accept_floor`	`_Number`	`runtime default`	—
`early_tolerance`	`_Number`	`runtime default`	—
`temperature`	`_Number`	`runtime default`	—
`delta`	`_Number`	`runtime default`	—
`beta`	`_Number`	`runtime default`	—
`spring_strength`	`_Number`	`runtime default`	—
`centering_strength`	`_Number`	`runtime default`	—
`epochs`	`_Integer`	`runtime default`	—
`crossing_penalty`	`_Number`	`runtime default`	—
`dangling_repulsion`	`_Number`	`runtime default`	—
`dangling_centroid_repulsion`	`_Number`	`runtime default`	—
`edge_edge_repulsion`	`_Number`	`runtime default`	—
`directional_force`	`_Number`	`runtime default`	—
`label_length_scale`	`_Number`	`runtime default`	—
`label_spring`	`_Number`	`runtime default`	—
`label_charge`	`_Number`	`runtime default`	—
`label_steps`	`_Integer`	`runtime default`	—
`label_layout`	`_LabelLayoutValue`	`runtime default`	—
`label_step`	`_Number`	`runtime default`	—
`label_early_tolerance`	`_Number`	`runtime default`	—
`label_max_delta_scale`	`_Number`	`runtime default`	—
`edge_vertex_repulsion`	`_Number`	`runtime default`	—
`epsilon`	`_Number`	`runtime default`	—
`incremental_energy`	`_Boolean`	`runtime default`	—
`algorithm`	`_LayoutAlgorithmValue`	`runtime default`	—
`nodes`	`_LayoutNodesValue`	`runtime default`	—
`direction`	`_LayoutDirectionValue`	`runtime default`	—
`rank_align`	`_RankAlignmentValue`	`runtime default`	—
`roots`	`_NodeIndices`	`runtime default`	—
`rank_same`	`_NodeGroups`	`runtime default`	—
`route_edge_weight`	`_Number`	`runtime default`	—
`route_exit_weight`	`_Number`	`runtime default`	—
`route_label_width_scale`	`_Number`	`runtime default`	—
`route_label_width_cap`	`_Number`	`runtime default`	—
`z_spring`	`_Number`	`runtime default`	—
`z_spring_growth`	`_Number`	`runtime default`	—
`length_scale`	`_Number`	`runtime default`	—

View generated signature source: docs/api/python/linnet-py.pyi:678