edge_options {g6R} | R Documentation |
Create Edge Options Configuration for G6 Graphs
Description
Configures the general options for edges in a G6 graph. These settings control the type, style, state, palette, and animation of edges.
Usage
edge_options(
type = c("line", "polyline", "arc", "quadratic", "cubic", "cubic-vertical",
"cubic-horizontal", "loop"),
style = edge_style_options(),
state = NULL,
palette = NULL,
animation = NULL
)
Arguments
type |
Edge type. Can be a built-in edge type name or a custom edge name. Built-in types include "line", "polyline", "arc", "quadratic", "cubic", "cubic-vertical", "cubic-horizontal", "loop", etc. Default: "line". |
style |
Edge style configuration. Controls the appearance of edges including color,
width, dash patterns, etc. Can be created with |
state |
Defines the style of the edge in different states, such as hover, selected, disabled, etc. Should be a list mapping state names to style configurations. Default: NULL. |
palette |
Defines the color palette of the edge, used to map colors based on different data. Default: NULL. |
animation |
Defines the animation effect of the edge. Can be created with
|
Details
Edge options allow defining how edges appear and behave in a G6 graph. This includes selecting edge types, setting styles, configuring state-based appearances, defining color palettes, and specifying animation effects.
Value
A list containing edge options configuration that can be passed to g6_options()
.
Examples
# Basic edge options with default line type
options <- edge_options()
# Curved edge with custom style
options <- edge_options(
type = "cubic",
style = edge_style_options(
stroke = "#1783FF",
lineWidth = 2,
endArrow = TRUE
)
)