Class GGroup

A group display object that can organize children with optional layout.

Hierarchy (View Summary)

GObject<IGGroup, G_GROUP>
- GGroup

Index

Properties

Methods

addEventListener addGear addRelation clone copy detach dispatchEvent dispose equals getAdvanced getAlpha getAspect getAutoSizeDisabled getBlendMode getColumnGap getCustomData getExcludeInvisibles getExtension getExtras getFilter getFilterData getGrayed getGroup getHeight getId getInitHeight getInitWidth getLayout getLineGap getLocked getMainGridIndex getMaxHeight getMaxWidth getMinHeight getMinWidth getName getPivotAsAnchor getPivotX getPivotY getRelations getRotation getScaleX getScaleY getSkewX getSkewY getSourceHeight getSourceWidth getTooltips getTouchable getVisible getWidth getX getY isDisposed listExtensions listGears listParents removeEventListener removeGear setAdvanced setAlpha setAspect setAutoSizeDisabled setBlendMode setColumnGap setCustomData setExcludeInvisibles setExtension setExtras setFilter setFilterData setGrayed setGroup setId setInitHeight setInitWidth setLayout setLineGap setLocked setMainGridIndex setMaxHeight setMaxWidth setMinHeight setMinWidth setName setPivot setPivotAsAnchor setRelations setRotation setScale setSize setSkew setSourceHeight setSourceWidth setTooltips setTouchable setVisible setX setXY setY

Properties

propertyType

propertyType: G_GROUP

Methods

addEventListener

addEventListener(type: string, listener: EventListener<GraphNodeEvent>): this
Parameters
- type: string
- listener: EventListener<GraphNodeEvent>
Returns this
Inherited from GObject.addEventListener
- Defined in node_modules/.pnpm/property-graph@4.1.0/node_modules/property-graph/dist/index.d.mts:98

addGear

addGear(gear: Gear): this
**** Gears *****
Parameters
- gear: Gear
Returns this
Inherited from GObject.addGear
- Defined in packages/core/src/properties/g-object.ts:166

addRelation

addRelation(relation: RelationDef): this
Parameters
- relation: RelationDef
Returns this
Inherited from GObject.addRelation
- Defined in packages/core/src/properties/g-object.ts:159

clone

clone(): this
Returns this
Inherited from GObject.clone
- Defined in packages/core/src/properties/property.ts:130

copy

copy(other: this, resolve?: PropertyResolver<Property<IProperty>>): this
Parameters
- other: this
- resolve: PropertyResolver<Property<IProperty>> = COPY_IDENTITY
Returns this
Inherited from GObject.copy
- Defined in packages/core/src/properties/property.ts:135

detach

detach(): this
Removes all inbound references to this object. At the end of the process the object is considered 'detached': it may hold references to child resources, but nothing holds references to it. A detached object may be re-attached.

Returns this
Inherited from GObject.detach
- Defined in packages/core/src/properties/property.ts:216

dispatchEvent

dispatchEvent(event: BaseEvent): this
Dispatches an event on the GraphNode, and on the associated Graph. Event types on the graph are prefixed, "node:[type]".
Parameters
- event: BaseEvent
Returns this
Inherited from GObject.dispatchEvent
- Defined in node_modules/.pnpm/property-graph@4.1.0/node_modules/property-graph/dist/index.d.mts:227

dispose

dispose(): void
Removes both inbound references to and outbound references from this object. At the end of the process the object holds no references, and nothing holds references to it. A disposed object is not reusable.

Returns void
Inherited from GObject.dispose
- Defined in node_modules/.pnpm/property-graph@4.1.0/node_modules/property-graph/dist/index.d.mts:168

equals

equals(other: this, skip?: Set<string>): boolean
Parameters
- other: this
- skip: Set<string> = EMPTY_SET
Returns boolean
Inherited from GObject.equals
- Defined in packages/core/src/properties/property.ts:188

getAdvanced

getAdvanced(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-group.ts:103

getAlpha

getAlpha(): number
Returns number
- Defined in packages/core/src/properties/g-group.ts:79

getAspect

getAspect(): boolean
Returns boolean
Inherited from GObject.getAspect
- Defined in packages/core/src/properties/g-object.ts:108

getAutoSizeDisabled

getAutoSizeDisabled(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-group.ts:109

getBlendMode

getBlendMode(): string
Returns string
Inherited from GObject.getBlendMode
- Defined in packages/core/src/properties/g-object.ts:145

getColumnGap

getColumnGap(): number
Returns number
- Defined in packages/core/src/properties/g-group.ts:100

getCustomData

getCustomData(): string
Returns string
Inherited from GObject.getCustomData
- Defined in packages/core/src/properties/g-object.ts:152

getExcludeInvisibles

getExcludeInvisibles(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-group.ts:106

getExtension

getExtension<Prop extends ExtensionProperty<IExtensibleProperty>>(
name: string,
): Prop
Type Parameters
- Prop extends ExtensionProperty<IExtensibleProperty>
Parameters
- name: string
Returns Prop
Inherited from GObject.getExtension
- Defined in packages/core/src/properties/extensible-property.ts:19

getExtras

getExtras(): Record<string, unknown>
Returns Record<string, unknown>
Inherited from GObject.getExtras
- Defined in packages/core/src/properties/property.ts:122

getFilter

getFilter(): string
Returns string
Inherited from GObject.getFilter
- Defined in packages/core/src/properties/g-object.ts:147

getFilterData

getFilterData(): string
Returns string
Inherited from GObject.getFilterData
- Defined in packages/core/src/properties/g-object.ts:149

getGrayed

getGrayed(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-group.ts:94

getGroup

getGroup(): string
Returns string
- Defined in packages/core/src/properties/g-group.ts:88

getHeight

getHeight(): number
Returns number
- Defined in packages/core/src/properties/g-group.ts:65

getId

getId(): string
Returns string
Inherited from GObject.getId
- Defined in packages/core/src/properties/g-object.ts:93

getInitHeight

getInitHeight(): number
Returns number
Inherited from GObject.getInitHeight
- Defined in packages/core/src/properties/g-object.ts:103

getInitWidth

getInitWidth(): number
Returns number
Inherited from GObject.getInitWidth
- Defined in packages/core/src/properties/g-object.ts:101

getLayout

getLayout(): number
Returns number
- Defined in packages/core/src/properties/g-group.ts:59

getLineGap

getLineGap(): number
Returns number
- Defined in packages/core/src/properties/g-group.ts:97

getLocked

getLocked(): boolean
Returns boolean
Overrides GObject.getLocked
- Defined in packages/core/src/properties/g-group.ts:66

getMainGridIndex

getMainGridIndex(): number
Returns number
- Defined in packages/core/src/properties/g-group.ts:112

getMaxHeight

getMaxHeight(): number
Returns number
Inherited from GObject.getMaxHeight
- Defined in packages/core/src/properties/g-object.ts:116

getMaxWidth

getMaxWidth(): number
Returns number
Inherited from GObject.getMaxWidth
- Defined in packages/core/src/properties/g-object.ts:112

getMinHeight

getMinHeight(): number
Returns number
Inherited from GObject.getMinHeight
- Defined in packages/core/src/properties/g-object.ts:114

getMinWidth

getMinWidth(): number
Returns number
Inherited from GObject.getMinWidth
- Defined in packages/core/src/properties/g-object.ts:110

getName

getName(): string
Returns string
Inherited from GObject.getName
- Defined in packages/core/src/properties/property.ts:114

getPivotAsAnchor

getPivotAsAnchor(): boolean
Returns boolean
Inherited from GObject.getPivotAsAnchor
- Defined in packages/core/src/properties/g-object.ts:121

getPivotX

getPivotX(): number
Returns number
Inherited from GObject.getPivotX
- Defined in packages/core/src/properties/g-object.ts:119

getPivotY

getPivotY(): number
Returns number
Inherited from GObject.getPivotY
- Defined in packages/core/src/properties/g-object.ts:120

getRelations

getRelations(): RelationDef[]
**** Relations *****

Returns RelationDef[]
Inherited from GObject.getRelations
- Defined in packages/core/src/properties/g-object.ts:157

getRotation

getRotation(): number
Returns number
- Defined in packages/core/src/properties/g-group.ts:82

getScaleX

getScaleX(): number
Returns number
Inherited from GObject.getScaleX
- Defined in packages/core/src/properties/g-object.ts:129

getScaleY

getScaleY(): number
Returns number
Inherited from GObject.getScaleY
- Defined in packages/core/src/properties/g-object.ts:130

getSkewX

getSkewX(): number
Returns number
Inherited from GObject.getSkewX
- Defined in packages/core/src/properties/g-object.ts:136

getSkewY

getSkewY(): number
Returns number
Inherited from GObject.getSkewY
- Defined in packages/core/src/properties/g-object.ts:137

getSourceHeight

getSourceHeight(): number
Returns number
Inherited from GObject.getSourceHeight
- Defined in packages/core/src/properties/g-object.ts:98

getSourceWidth

getSourceWidth(): number
Returns number
Inherited from GObject.getSourceWidth
- Defined in packages/core/src/properties/g-object.ts:96

getTooltips

getTooltips(): string
Returns string
Inherited from GObject.getTooltips
- Defined in packages/core/src/properties/g-object.ts:143

getTouchable

getTouchable(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-group.ts:91

getVisible

getVisible(): boolean
Returns boolean
- Defined in packages/core/src/properties/g-group.ts:85

getWidth

getWidth(): number
Returns number
- Defined in packages/core/src/properties/g-group.ts:64

getX

getX(): number
Returns number
- Defined in packages/core/src/properties/g-group.ts:62

getY

getY(): number
Returns number
- Defined in packages/core/src/properties/g-group.ts:63

isDisposed

isDisposed(): boolean
Returns true if the node has been permanently removed from the graph.

Returns boolean
Inherited from GObject.isDisposed
- Defined in node_modules/.pnpm/property-graph@4.1.0/node_modules/property-graph/dist/index.d.mts:162

listExtensions

listExtensions(): ExtensionProperty<IExtensibleProperty>[]
Returns ExtensionProperty<IExtensibleProperty>[]
Inherited from GObject.listExtensions
- Defined in packages/core/src/properties/extensible-property.ts:27

listGears

listGears(): Gear[]
Returns Gear[]
Inherited from GObject.listGears
- Defined in packages/core/src/properties/g-object.ts:168

listParents

listParents(): Property<IProperty>[]
Returns Property<IProperty>[]
Inherited from GObject.listParents
- Defined in packages/core/src/properties/property.ts:221

removeEventListener

removeEventListener(type: string, listener: EventListener<GraphNodeEvent>): this
Parameters
- type: string
- listener: EventListener<GraphNodeEvent>
Returns this
Inherited from GObject.removeEventListener
- Defined in node_modules/.pnpm/property-graph@4.1.0/node_modules/property-graph/dist/index.d.mts:99

removeGear

removeGear(gear: Gear): this
Parameters
- gear: Gear
Returns this
Inherited from GObject.removeGear
- Defined in packages/core/src/properties/g-object.ts:167

setAdvanced

setAdvanced(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-group.ts:104

setAlpha

setAlpha(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-group.ts:80

setAspect

setAspect(v: boolean): this
Parameters
- v: boolean
Returns this
Inherited from GObject.setAspect
- Defined in packages/core/src/properties/g-object.ts:109

setAutoSizeDisabled

setAutoSizeDisabled(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-group.ts:110

setBlendMode

setBlendMode(v: string): this
Parameters
- v: string
Returns this
Inherited from GObject.setBlendMode
- Defined in packages/core/src/properties/g-object.ts:146

setColumnGap

setColumnGap(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-group.ts:101

setCustomData

setCustomData(v: string): this
Parameters
- v: string
Returns this
Inherited from GObject.setCustomData
- Defined in packages/core/src/properties/g-object.ts:153

setExcludeInvisibles

setExcludeInvisibles(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-group.ts:107

setExtension

setExtension<Prop extends ExtensionProperty<IExtensibleProperty>>(
name: string,
extensionProperty: Prop,
): this
Type Parameters
- Prop extends ExtensionProperty<IExtensibleProperty>
Parameters
- name: string
- extensionProperty: Prop
Returns this
Inherited from GObject.setExtension
- Defined in packages/core/src/properties/extensible-property.ts:23

setExtras

setExtras(extras: Record<string, unknown>): this
Parameters
- extras: Record<string, unknown>
Returns this
Inherited from GObject.setExtras
- Defined in packages/core/src/properties/property.ts:126

setFilter

setFilter(v: string): this
Parameters
- v: string
Returns this
Inherited from GObject.setFilter
- Defined in packages/core/src/properties/g-object.ts:148

setFilterData

setFilterData(v: string): this
Parameters
- v: string
Returns this
Inherited from GObject.setFilterData
- Defined in packages/core/src/properties/g-object.ts:150

setGrayed

setGrayed(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-group.ts:95

setGroup

setGroup(v: string): this
Parameters
- v: string
Returns this
- Defined in packages/core/src/properties/g-group.ts:89

setId

setId(id: string): this
Parameters
- id: string
Returns this
Inherited from GObject.setId
- Defined in packages/core/src/properties/g-object.ts:94

setInitHeight

setInitHeight(v: number): this
Parameters
- v: number
Returns this
Inherited from GObject.setInitHeight
- Defined in packages/core/src/properties/g-object.ts:104

setInitWidth

setInitWidth(v: number): this
Parameters
- v: number
Returns this
Inherited from GObject.setInitWidth
- Defined in packages/core/src/properties/g-object.ts:102

setLayout

setLayout(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-group.ts:60

setLineGap

setLineGap(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-group.ts:98

setLocked

setLocked(v: boolean): this
Parameters
- v: boolean
Returns this
Overrides GObject.setLocked
- Defined in packages/core/src/properties/g-group.ts:75

setMainGridIndex

setMainGridIndex(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-group.ts:113

setMaxHeight

setMaxHeight(v: number): this
Parameters
- v: number
Returns this
Inherited from GObject.setMaxHeight
- Defined in packages/core/src/properties/g-object.ts:117

setMaxWidth

setMaxWidth(v: number): this
Parameters
- v: number
Returns this
Inherited from GObject.setMaxWidth
- Defined in packages/core/src/properties/g-object.ts:113

setMinHeight

setMinHeight(v: number): this
Parameters
- v: number
Returns this
Inherited from GObject.setMinHeight
- Defined in packages/core/src/properties/g-object.ts:115

setMinWidth

setMinWidth(v: number): this
Parameters
- v: number
Returns this
Inherited from GObject.setMinWidth
- Defined in packages/core/src/properties/g-object.ts:111

setName

setName(name: string): this
Parameters
- name: string
Returns this
Inherited from GObject.setName
- Defined in packages/core/src/properties/property.ts:118

setPivot

setPivot(x: number, y: number, anchor?: boolean): this
Parameters
- x: number
- y: number
- anchor: boolean = false
Returns this
Inherited from GObject.setPivot
- Defined in packages/core/src/properties/g-object.ts:122

setPivotAsAnchor

setPivotAsAnchor(v: boolean): this
Parameters
- v: boolean
Returns this
Inherited from GObject.setPivotAsAnchor
- Defined in packages/core/src/properties/g-object.ts:127

setRelations

setRelations(relations: RelationDef[]): this
Parameters
- relations: RelationDef[]
Returns this
Inherited from GObject.setRelations
- Defined in packages/core/src/properties/g-object.ts:158

setRotation

setRotation(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-group.ts:83

setScale

setScale(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
Inherited from GObject.setScale
- Defined in packages/core/src/properties/g-object.ts:131

setSize

setSize(w: number, h: number): this
Parameters
- w: number
- h: number
Returns this
- Defined in packages/core/src/properties/g-group.ts:71

setSkew

setSkew(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
Inherited from GObject.setSkew
- Defined in packages/core/src/properties/g-object.ts:138

setSourceHeight

setSourceHeight(v: number): this
Parameters
- v: number
Returns this
Inherited from GObject.setSourceHeight
- Defined in packages/core/src/properties/g-object.ts:99

setSourceWidth

setSourceWidth(v: number): this
Parameters
- v: number
Returns this
Inherited from GObject.setSourceWidth
- Defined in packages/core/src/properties/g-object.ts:97

setTooltips

setTooltips(v: string): this
Parameters
- v: string
Returns this
Inherited from GObject.setTooltips
- Defined in packages/core/src/properties/g-object.ts:144

setTouchable

setTouchable(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-group.ts:92

setVisible

setVisible(v: boolean): this
Parameters
- v: boolean
Returns this
- Defined in packages/core/src/properties/g-group.ts:86

setX

setX(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-group.ts:76

setXY

setXY(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
- Defined in packages/core/src/properties/g-group.ts:67

setY

setY(v: number): this
Parameters
- v: number
Returns this
- Defined in packages/core/src/properties/g-group.ts:77