Package: github.com/d2lang/elk-go/graphjson

package graphjson Import Path github.com/d2lang/elk-go/graphjson (on go.dev) Dependency Relation imports 5 packages, and imported by 2 packages

Involved Source Files d model.go Package graphjson defines ELK's JSON graph interchange model. model_json.go

Package-Level Type Names (total 9)

/* sort by: alphabet | popularity */

type Edge (struct) Edge accepts both ELK's extended sources/targets form and its deprecated primitive source/target form. Fields (total 16) AdditionalFields map[string]json.RawMessage BendPoints []Point Container *ID ID ID JunctionPoints []Point Labels []*Label LayoutOptions LayoutOptions Sections []*EdgeSection Source *ID SourcePoint *Point SourcePort *ID Sources []ID Target *ID TargetPoint *Point TargetPort *ID Targets []ID Methods (total 3) (*Edge) LayoutOptionKeys() []string LayoutOptionKeys returns the layout-option member order captured while decoding JSON. Programmatically constructed edges return nil. ( Edge) MarshalJSON() ([]byte, error) (*Edge) UnmarshalJSON(data []byte) error Implements (at least 4) Edge : github.com/goccy/go-json.Marshaler *Edge : github.com/goccy/go-json.Unmarshaler Edge : encoding/json/v2.Marshaler *Edge : encoding/json/v2.Unmarshaler

type EdgeSection (struct) EdgeSection is one connected piece of an edge route. Fields (total 10) AdditionalFields map[string]json.RawMessage BendPoints []Point EndPoint *Point ID ID IncomingSections []ID IncomingShape *ID LayoutOptions LayoutOptions OutgoingSections []ID OutgoingShape *ID StartPoint *Point Methods (total 3) (*EdgeSection) LayoutOptionKeys() []string LayoutOptionKeys returns the layout-option member order captured while decoding JSON. Programmatically constructed sections return nil. ( EdgeSection) MarshalJSON() ([]byte, error) (*EdgeSection) UnmarshalJSON(data []byte) error Implements (at least 4) EdgeSection : github.com/goccy/go-json.Marshaler *EdgeSection : github.com/goccy/go-json.Unmarshaler EdgeSection : encoding/json/v2.Marshaler *EdgeSection : encoding/json/v2.Unmarshaler

type Graph = Node (struct) Graph is the root-node spelling used by Layout.

type ID (struct) ID is an ELK graph identifier. ELK's documented API uses string IDs, while its JSON importer also accepts integral JSON numbers. ID preserves which representation was supplied. Methods (total 6) ( ID) Int64() (int64, bool) Int64 returns the numeric identifier and whether this ID is numeric. ( ID) IsNumber() bool IsNumber reports whether the ID uses the JSON number representation. ( ID) IsValid() bool IsValid reports whether the ID was explicitly initialized. ( ID) MarshalJSON() ([]byte, error) ( ID) String() string String returns the identifier's canonical text representation. (*ID) UnmarshalJSON(data []byte) error Implements (at least 7) ID : github.com/goccy/go-json.Marshaler *ID : github.com/goccy/go-json.Unmarshaler ID : database/sql/driver.Validator ID : encoding/json/v2.Marshaler *ID : encoding/json/v2.Unmarshaler ID : expvar.Var ID : fmt.Stringer As Outputs Of (at least 3) func IDPtr(id ID) *ID func IntID(value int64) ID func StringID(value string) ID As Inputs Of (at least one exported) func IDPtr(id ID) *ID

type Label (struct) Label is a shape attached to a node, port, or edge. Fields (total 9) AdditionalFields map[string]json.RawMessage Height *float64 ID *ID Labels []*Label LayoutOptions LayoutOptions Text *string Width *float64 X *float64 Y *float64 Methods (total 3) (*Label) LayoutOptionKeys() []string LayoutOptionKeys returns the layout-option member order captured while decoding JSON. Programmatically constructed labels return nil. ( Label) MarshalJSON() ([]byte, error) (*Label) UnmarshalJSON(data []byte) error Implements (at least 4) Label : github.com/goccy/go-json.Marshaler *Label : github.com/goccy/go-json.Unmarshaler Label : encoding/json/v2.Marshaler *Label : encoding/json/v2.Unmarshaler

type LayoutOptions (map) LayoutOptions contains layout option values. ELK's JavaScript facade accepts strings as documented as well as JSON booleans and numbers.

type Node (struct) Node is both ELK's root graph type and its recursive node type. Nil slices are absent JSON members; non-nil empty slices are emitted as empty arrays. Fields (total 12) AdditionalFields map[string]json.RawMessage Children []*Node Edges []*Edge Height *float64 ID ID IndividualSpacings LayoutOptions Labels []*Label LayoutOptions LayoutOptions Ports []*Port Width *float64 X *float64 Y *float64 Methods (total 4) (*Node) IndividualSpacingKeys() []string IndividualSpacingKeys returns the individual-spacing member order captured while decoding JSON. Programmatically constructed nodes return nil. (*Node) LayoutOptionKeys() []string LayoutOptionKeys returns the layout-option member order captured while decoding JSON. Programmatically constructed nodes return nil. ( Node) MarshalJSON() ([]byte, error) (*Node) UnmarshalJSON(data []byte) error Implements (at least 4) Node : github.com/goccy/go-json.Marshaler *Node : github.com/goccy/go-json.Unmarshaler Node : encoding/json/v2.Marshaler *Node : encoding/json/v2.Unmarshaler

type Point (struct) Point is a two-dimensional point in parent-relative ELK coordinates. Fields (total 2) X float64 Y float64 Methods (only one) ( Point) MarshalJSON() ([]byte, error) Implements (at least 2) Point : github.com/goccy/go-json.Marshaler Point : encoding/json/v2.Marshaler

type Port (struct) Port is a connectable shape owned by a node. Fields (total 8) AdditionalFields map[string]json.RawMessage Height *float64 ID ID Labels []*Label LayoutOptions LayoutOptions Width *float64 X *float64 Y *float64 Methods (total 3) (*Port) LayoutOptionKeys() []string LayoutOptionKeys returns the layout-option member order captured while decoding JSON. Programmatically constructed ports return nil. ( Port) MarshalJSON() ([]byte, error) (*Port) UnmarshalJSON(data []byte) error Implements (at least 4) Port : github.com/goccy/go-json.Marshaler *Port : github.com/goccy/go-json.Unmarshaler Port : encoding/json/v2.Marshaler *Port : encoding/json/v2.Unmarshaler

Package-Level Functions (total 6)

func Float64(value float64) *float64 Float64 returns a pointer suitable for optional numeric graph fields.

func IDPtr(id ID) *ID IDPtr returns a pointer to a copy of id.

func IntID(value int64) ID IntID constructs an integer-valued graph identifier.

func Number(value *float64) float64 Number returns value, or zero when value is nil.

func String(value string) *string String returns a pointer suitable for optional text fields.

func StringID(value string) ID StringID constructs a string-valued graph identifier.