g6/packages/site/docs/apis/interfaces/graph/Specification.en.md
pomelo 339f28c564
feat: fix plugin demo with extensions (#4885)
* feat: fix plugin demo with extensions

* Chore:check translate (#4886)

* feat: check plugins

* chore: update docs
2023-08-31 01:43:08 +08:00

6.7 KiB

title
Specification

Overview - v5.0.0-alpha.9 / Modules / graph / Specification

graph.Specification

Type parameters

Name Type
B extends BehaviorRegistry
T extends ThemeRegistry

Properties

animate

Optional animate: AnimateCfg

global animate

Defined in

packages/g6/src/types/spec.ts:113


autoFit

Optional autoFit: "center" | "view" | { effectTiming?: Partial<Pick<IAnimationEffectTiming, "duration" | "easing" | "easingFunction">> ; padding?: Padding ; rules?: FitViewRules ; type: "view" } | { effectTiming?: Partial<Pick<IAnimationEffectTiming, "duration" | "easing" | "easingFunction">> ; type: "center" } | { alignment?: GraphAlignment ; effectTiming?: Partial<Pick<IAnimationEffectTiming, "duration" | "easing" | "easingFunction">> ; position: Point ; type: "position" }

Defined in

packages/g6/src/types/spec.ts:49


backgroundCanvas

Optional backgroundCanvas: Canvas

Defined in

packages/g6/src/types/spec.ts:36


canvas

Optional canvas: Canvas

Defined in

packages/g6/src/types/spec.ts:37


combo

Optional combo: ComboEncode | (data: ComboModel) => ComboDisplayModel

Defined in

packages/g6/src/types/spec.ts:83


comboState

Optional comboState: Object

Index signature

▪ [stateName: string]: (data: ComboModel) => ComboDisplayModel | ComboShapesEncode

Defined in

packages/g6/src/types/spec.ts:96


container

Optional container: string | HTMLElement

Defined in

packages/g6/src/types/spec.ts:35


data

Optional data: DataConfig

data

Defined in

packages/g6/src/types/spec.ts:71


edge

Optional edge: EdgeEncode | (data: EdgeModel) => EdgeDisplayModel

Defined in

packages/g6/src/types/spec.ts:82


edgeState

Optional edgeState: Object

Index signature

▪ [stateName: string]: (data: EdgeModel) => EdgeDisplayModel | EdgeShapesEncode

Defined in

packages/g6/src/types/spec.ts:91


enableStack

Optional enableStack: boolean

Defined in

packages/g6/src/types/spec.ts:128


height

Optional height: number

Defined in

packages/g6/src/types/spec.ts:40


layout

Optional layout: LayoutOptions | LayoutOptions[]

layout

Defined in

packages/g6/src/types/spec.ts:103


mode

Optional mode: string

Defined in

packages/g6/src/types/spec.ts:110


modes

Optional modes: Object

interaction

Index signature

▪ [mode: string]: BehaviorOptionsOf<B>[]

Defined in

packages/g6/src/types/spec.ts:106


node

Optional node: NodeEncode | (data: NodeModel) => NodeDisplayModel

item

Defined in

packages/g6/src/types/spec.ts:81


nodeState

Optional nodeState: Object

item state styles

Index signature

▪ [stateName: string]: (data: NodeModel) => NodeDisplayModel | NodeShapesEncode

Defined in

packages/g6/src/types/spec.ts:86


optimizeThreshold

Optional optimizeThreshold: number

Defined in

packages/g6/src/types/spec.ts:68


plugins

Optional plugins: (string | { [cfgName: string]: unknown; key: string ; type: string })[]

free plugins

Defined in

packages/g6/src/types/spec.ts:116


renderer

Optional renderer: RendererName | { headless: boolean ; pixelRatio: number ; type: RendererName }

Defined in

packages/g6/src/types/spec.ts:41


stackCfg

Optional stackCfg: StackCfg

Defined in

packages/g6/src/types/spec.ts:130


theme

Optional theme: ThemeOptionsOf<T>

theme

Defined in

packages/g6/src/types/spec.ts:126


transform

Optional transform: string[] | { [param: string]: unknown; type: string }[] | TransformerFn[]

Defined in

packages/g6/src/types/spec.ts:72


transientCanvas

Optional transientCanvas: Canvas

Defined in

packages/g6/src/types/spec.ts:38


width

Optional width: number

Defined in

packages/g6/src/types/spec.ts:39


zoom

Optional zoom: number

Defined in

packages/g6/src/types/spec.ts:48