API / geotoolkit / flowcharts / shapes / IComponent / IComponent
shapes.IComponent.IComponent
Base interface for all visuals that can be placed into Diagram
Interface
IComponent↳
ILink
Constructors
Methods
Methods
▸ Abstract getCategory(): string
Drawing category. The default value is 'default'
string
▸ getClassName(): string
string
▸ Abstract getDefaultIconSize(): Dimension
▸ Abstract getDefaultSize(): Dimension
Defines default visual size in UI units (pixels by default). Default value is (50, 50)
▸ Abstract getGeometry(): Node
gets geometry for the drawing
▸ Abstract getLinkPoints(): Point[]
Gets default link points in model space. If not specified, the 'outline' property will be used. If 'ouline' is not set, then the shape becomes 'unconnectable'
Point[]
▸ Abstract getOutline(): GraphicsPath
gets outline for the drawing. This outline will be used as path with possible connection along. By default, no outline will be used
▸ Abstract getPrototypeId(): string
Returns component class, string value
string
▸ Abstract getPrototypeName(): string
The name of the component
string
▸ Abstract getSearchKeywords(): string[]
Cue words for the component search. By default, the shape will not be searched
string[]
▸ Abstract getUrl(): string
Gets URL for an icon
string
▸ Abstract setDefaultSize(dimension): IComponent
Defines default visual size in UI units (pixels by default). Default value is (50, 50)
| Name | Type | Description |
|---|---|---|
dimension | Dimension | new default dimension |
this
▸ Abstract setLinkPoints(points): void
Sets link points. Link points must be defined in the shapes's model space
| Name | Type | Description |
|---|---|---|
points | Point[] | an array of model-space points that represent possible connections |
void
▸ Abstract setText(textOptions): IComponent
Sets text and its options
| Name | Type | Description |
|---|---|---|
textOptions | Text | text and/or its options |
this instance
▸ Abstract setUrl(url): IComponent
| Name | Type |
|---|---|
url | string |
this
▸ Static getClassName(): string
string