Last updated

API / geotoolkit / schematics / labeling / ConnectorShape / ConnectorShape

Class: ConnectorShape

labeling.ConnectorShape.ConnectorShape

Abstract label connector shape representation

Hierarchy

Table of contents

Constructors
Methods
Css Properties
Name Type Description
labeldataLabelData
labeldata-anchortypeAnchorTypeAnchor type
labeldata-nodeComponentNodeComponent node to label
labeldata-node-automodellimitsmodebooleanAuto model limits mode
labeldata-node-boundsRectDefine position of the group in the parent
labeldata-node-bounds-heightnumberHeight
labeldata-node-bounds-readonlybooleanReadonly
labeldata-node-bounds-widthnumberWidth
labeldata-node-bounds-xnumberLeft
labeldata-node-bounds-ynumberTop
labeldata-node-clippingbooleanEnable clipping, this does not consider the clipstyle, it is related to bounds-clipping
labeldata-node-clipstyleClipStyleClipping style
labeldata-node-clipstyle-evenoddbooleanTrue if evenodd mode is on ('nonzero' mode otherwise)
labeldata-node-clipstyle-geometryGraphicsPathClipping geometry
labeldata-node-clipstyle-geometry-boundsRectBounds
labeldata-node-clipstyleGraphicsPathClipping style
labeldata-node-contentorientationOrientationContent orientation
labeldata-node-cssclassstringThe css class name of this node
labeldata-node-csscursorstringCSS cursor associated with node
labeldata-node-cssstylestringCSS style to be applied to inserted elements
labeldata-node-descriptionstringElement description
labeldata-node-fillstylestringFill style
labeldata-node-fillstyleFillStyleFill style
labeldata-node-fillstyle-colorstringColor in CSS form
labeldata-node-fillstyle-evenoddmodebooleanEven-odd fill mode
labeldata-node-fillstyle-fillpatternPatternPattern
labeldata-node-fillstyle-fillpattern-containernamestringAn optional container name, which creates an image pattern. This parameter is used for serialization if you want to save are reference to pattern instead of the pattern itself
labeldata-node-fillstyle-fillpattern-patternnamestringName of this pattern for indexing
labeldata-node-fillstyle-fillpattern-scalablebooleanFlag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported)
labeldata-node-fillstyle-foregroundstringForeground color
labeldata-node-fillstyle-patternPatternPattern
labeldata-node-horizontalflipbooleanHorizontal axis goes from right to left
labeldata-node-idstring | numberId of the node, its a unique identifier
labeldata-node-infinitybooleanMode to render outside the model limits
labeldata-node-layoutstyleLayoutStyleLayout style to be used for parent layout
labeldata-node-layoutstyle-constraintSizeConstraintLayout constrains
labeldata-node-layoutstyle-flexgrownumberNumber specifying how much the item will grow relative to the rest of the items inside the same container
labeldata-node-layoutstyle-flexshrinknumberNumber specifying how much the item will shrink relative to the rest of the items inside the same container
labeldata-node-layoutstyle-floatstringFloat position
labeldata-node-layoutstyle-positionstringLayout position
labeldata-node-layoutstyle-sizenumber | stringLayout size
labeldata-node-linestylestringLine style
labeldata-node-linestyleLineStyleLine style
labeldata-node-linestyle-colorstringColor in CSS form
labeldata-node-linestyle-fillstringOptional fill style to be used to fill lines generated with this style
labeldata-node-linestyle-fillFillStyleOptional fill style to be used to fill lines generated with this style
labeldata-node-linestyle-linecapCapStyleThe line cap style
labeldata-node-linestyle-linedashoffsetnumberLine dash offset of dashed line
labeldata-node-linestyle-linejoinJoinStyleThe line join style
labeldata-node-linestyle-pixelsnapmodebooleanPixel Snap Mode, default(
labeldata-node-linestyle-scalablebooleanTrue if width should depend on transformation
labeldata-node-linestyle-unitstringOptional unit for the width
labeldata-node-linestyle-widthnumber | stringThe line thickness
labeldata-node-localtransformTransformationLocal transformation
labeldata-node-localtransform-dxnumberX axis translation
labeldata-node-localtransform-dynumberY axis translation
labeldata-node-localtransform-xxnumberX scale
labeldata-node-localtransform-xynumberXy skew
labeldata-node-localtransform-yxnumberYx skew
labeldata-node-localtransform-yynumberY scale
labeldata-node-marginsnumber | stringIt has properties for specifying the margins for each side
labeldata-node-modellimitsRectDefine inner model coordinates of the group
labeldata-node-namestringName of the node. It is often used for debugging purposes or to simplify queries
labeldata-node-opacitynumberNode opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context
labeldata-node-opacityblendmodeBlendModeNode opacity mode to blend it
labeldata-node-paddingnumber | stringIt has properties for specifying the padding for each side
labeldata-node-pickingchildrenbooleanEnable picking children
labeldata-node-rectboundsRectGeometry bounds
labeldata-node-scalescrollstrategyScaleScrollStrategyScale scroll strategy
labeldata-node-scalescrollstrategy-enabledbooleanEnable flag
labeldata-node-selectablebooleanSelectable node, a boolean to determine if selection should consider this node
labeldata-node-taganyCustom information associated with node. It is a user object which can be used by client code to store information or attach an application object to the shape
labeldata-node-transformstringAdditional CSS transformation applied to node or 'none'
labeldata-node-transformTransformationAdditional CSS transformation applied to node or 'none'
labeldata-node-verticalflipbooleanVertical axis goes from bottom to top
labeldata-node-viewcachebooleanView cache to cache child nodes
labeldata-node-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
labeldata-node-z-indexnumberDefine node z-index
labeldata-nodeindexnumberThe node virtual index
labeldata-nodeinfostringThe node information
labeldata-xlabelnumberLabel x-position
labeldata-ylabelnumberLabel y-position
linestylestring
linestyleLineStyle
visibleboolean

Contents

Constructors

new ConnectorShape(options)

Protected new ConnectorShape(options?)

Parameters

Name Type
Optional optionsOptions
Methods

getClassName

getClassName(): string

Returns

string


getLabelData

getLabelData(): LabelData

Gets label data

Returns

LabelData


getLineStyle

getLineStyle(): LineStyle

Gets line style

Returns

LineStyle

current line style


getProperties

getProperties(): OptionsOut

Returns all the properties pertaining to this object

Returns

OptionsOut

An object containing the properties to set


getVisible

getVisible(): boolean

Return visibility of the connector

Returns

boolean

true if connector is visible


render

Abstract render(context): void

Renders itself

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

void


setLabelData

setLabelData(labelData): ConnectorShape

Sets label data

Parameters

Name Type Description
labelDataLabelDatalabel Data

Returns

ConnectorShape

this


setLineStyle

setLineStyle(lineStyle, merge?): ConnectorShape

Sets line style

Parameters

Name Type Description
lineStyleTypeline style or options
Optional mergebooleantrue if you want to merge lineStyle with existing attribute, false by default

Returns

ConnectorShape

this


setProperties

setProperties(options?): ConnectorShape

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional optionsOptionsAn object containing the properties to set

Returns

ConnectorShape

this


setVisible

setVisible(value): ConnectorShape

Sets visibility of the node.

Parameters

Name Type Description
valuebooleanvisibility flag

Returns

ConnectorShape

this


getClassName

Static getClassName(): string

Returns

string