Last updated

API / geotoolkit / flowcharts / shapes / IComponent / IComponent

Class: IComponent

shapes.IComponent.IComponent

Base interface for all visuals that can be placed into Diagram

Interface

Hierarchy

Implemented by

Table of contents

Constructors
Methods

Contents

Constructors

new IComponent()

new IComponent()

Methods

getCategory

Abstract getCategory(): string

Drawing category. The default value is 'default'

Returns

string


getClassName

getClassName(): string

Returns

string


getDefaultIconSize

Abstract getDefaultIconSize(): Dimension

Returns

Dimension


getDefaultSize

Abstract getDefaultSize(): Dimension

Defines default visual size in UI units (pixels by default). Default value is (50, 50)

Returns

Dimension


getGeometry

Abstract getGeometry(): Node

gets geometry for the drawing

Returns

Node


getLinkPoints

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'

Returns

Point[]


getOutline

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

Returns

GraphicsPath


getPrototypeId

Abstract getPrototypeId(): string

Returns component class, string value

Returns

string


getPrototypeName

Abstract getPrototypeName(): string

The name of the component

Returns

string


getSearchKeywords

Abstract getSearchKeywords(): string[]

Cue words for the component search. By default, the shape will not be searched

Returns

string[]


getUrl

Abstract getUrl(): string

Gets URL for an icon

Returns

string


setDefaultSize

Abstract setDefaultSize(dimension): IComponent

Defines default visual size in UI units (pixels by default). Default value is (50, 50)

Parameters

Name Type Description
dimensionDimensionnew default dimension

Returns

IComponent

this


setLinkPoints

Abstract setLinkPoints(points): void

Sets link points. Link points must be defined in the shapes's model space

Parameters

Name Type Description
pointsPoint[]an array of model-space points that represent possible connections

Returns

void


setText

Abstract setText(textOptions): IComponent

Sets text and its options

Parameters

Name Type Description
textOptionsTexttext and/or its options

Returns

IComponent

this instance


setUrl

Abstract setUrl(url): IComponent

Parameters

Name Type
urlstring

Returns

IComponent

this


getClassName

Static getClassName(): string

Returns

string