API / geotoolkit / schematics / labeling / LabelData / LabelData

Class: LabelData

labeling.LabelData.LabelData

Label data structure to use by a LabelingStrategy.

Constructors

new LabelData(params)

Accessors

anchorType	node	nodeInfo
xConnector	xLabel	yConnector
yLabel

Methods

getClassName	getProperties	setProperties
getClassName

Css Properties

Name	Type	Description
`anchortype`	`AnchorType`	Anchor type
`node`	`ComponentNode`	Component node to label
`node-automodellimitsmode`	`boolean`	Auto model limits mode
`node-bounds`	`Rect`	Define position of the group in the parent
`node-bounds-height`	`number`	Height
`node-bounds-readonly`	`boolean`	Readonly
`node-bounds-width`	`number`	Width
`node-bounds-x`	`number`	Left
`node-bounds-y`	`number`	Top
`node-clipping`	`boolean`	Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping
`node-clipstyle`	`ClipStyle`	Clipping style
`node-clipstyle-evenodd`	`boolean`	True if evenodd mode is on ('nonzero' mode otherwise)
`node-clipstyle-geometry`	`GraphicsPath`	Clipping geometry
`node-clipstyle-geometry-bounds`	`Rect`	Bounds
`node-clipstyle`	`GraphicsPath`	Clipping style
`node-contentorientation`	`Orientation`	Content orientation
`node-cssclass`	`string`	The css class name of this node
`node-csscursor`	`string`	CSS cursor associated with node
`node-cssstyle`	`string`	CSS style to be applied to inserted elements
`node-description`	`string`	Element description
`node-fillstyle`	`string`	Fill style
`node-fillstyle`	`FillStyle`	Fill style
`node-fillstyle-color`	`string`	Color in CSS form
`node-fillstyle-evenoddmode`	`boolean`	Even-odd fill mode
`node-fillstyle-fillpattern`	`Pattern`	Pattern
`node-fillstyle-fillpattern-containername`	`string`	An 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
`node-fillstyle-fillpattern-patternname`	`string`	Name of this pattern for indexing
`node-fillstyle-fillpattern-scalable`	`boolean`	Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported)
`node-fillstyle-foreground`	`string`	Foreground color
`node-fillstyle-pattern`	`Pattern`	Pattern
`node-horizontalflip`	`boolean`	Horizontal axis goes from right to left
`node-id`	`string \| number`	Id of the node, its a unique identifier
`node-infinity`	`boolean`	Mode to render outside the model limits
`node-layoutstyle`	`LayoutStyle`	Layout style to be used for parent layout
`node-layoutstyle-constraint`	`SizeConstraint`	Layout constrains
`node-layoutstyle-flexgrow`	`number`	Number specifying how much the item will grow relative to the rest of the items inside the same container
`node-layoutstyle-flexshrink`	`number`	Number specifying how much the item will shrink relative to the rest of the items inside the same container
`node-layoutstyle-float`	`string`	Float position
`node-layoutstyle-position`	`string`	Layout position
`node-layoutstyle-size`	`number \| string`	Layout size
`node-linestyle`	`string`	Line style
`node-linestyle`	`LineStyle`	Line style
`node-linestyle-color`	`string`	Color in CSS form
`node-linestyle-fill`	`string`	Optional fill style to be used to fill lines generated with this style
`node-linestyle-fill`	`FillStyle`	Optional fill style to be used to fill lines generated with this style
`node-linestyle-linecap`	`CapStyle`	The line cap style
`node-linestyle-linedashoffset`	`number`	Line dash offset of dashed line
`node-linestyle-linejoin`	`JoinStyle`	The line join style
`node-linestyle-pixelsnapmode`	`boolean`	Pixel Snap Mode, default(
`node-linestyle-scalable`	`boolean`	True if width should depend on transformation
`node-linestyle-unit`	`string`	Optional unit for the width
`node-linestyle-width`	`number \| string`	The line thickness
`node-localtransform`	`Transformation`	Local transformation
`node-localtransform-dx`	`number`	X axis translation
`node-localtransform-dy`	`number`	Y axis translation
`node-localtransform-xx`	`number`	X scale
`node-localtransform-xy`	`number`	Xy skew
`node-localtransform-yx`	`number`	Yx skew
`node-localtransform-yy`	`number`	Y scale
`node-margins`	`number \| string`	It has properties for specifying the margins for each side
`node-modellimits`	`Rect`	Define inner model coordinates of the group
`node-name`	`string`	Name of the node. It is often used for debugging purposes or to simplify queries
`node-opacity`	`number`	Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context
`node-opacityblendmode`	`BlendMode`	Node opacity mode to blend it
`node-padding`	`number \| string`	It has properties for specifying the padding for each side
`node-pickingchildren`	`boolean`	Enable picking children
`node-rectbounds`	`Rect`	Geometry bounds
`node-scalescrollstrategy`	`ScaleScrollStrategy`	Scale scroll strategy
`node-scalescrollstrategy-enabled`	`boolean`	Enable flag
`node-selectable`	`boolean`	Selectable node, a boolean to determine if selection should consider this node
`node-tag`	`any`	Custom 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
`node-transform`	`string`	Additional CSS transformation applied to node or 'none'
`node-transform`	`Transformation`	Additional CSS transformation applied to node or 'none'
`node-verticalflip`	`boolean`	Vertical axis goes from bottom to top
`node-viewcache`	`boolean`	View cache to cache child nodes
`node-visible`	`boolean`	Visibility of the node, a boolean to determine if the node should be rendered or not
`node-z-index`	`number`	Define node z-index
`nodeindex`	`number`	The node virtual index
`nodeinfo`	`string`	The node information
`xlabel`	`number`	Label x-position
`ylabel`	`number`	Label y-position

Constructors

new LabelData(params)

• new LabelData(params?)

Parameters

Name	Type
`Optional` `params`	`Options`

Accessors

anchorType

• get anchorType(): AnchorType

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#anchorType

Returns

AnchorType

• set anchorType(value): void

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#anchorType

Parameters

Name	Type
`value`	`AnchorType`

Returns

void

node

• get node(): ComponentNode

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#node

Returns

ComponentNode

• set node(value): void

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#node

Parameters

Name	Type
`value`	`ComponentNode`

Returns

void

nodeInfo

• get nodeInfo(): string

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#nodeInfo

Returns

string

• set nodeInfo(value): void

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#nodeInfo

Parameters

Name	Type
`value`	`string`

Returns

void

xConnector

• get xConnector(): any[]

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#xConnector

Returns

any[]

• set xConnector(value): void

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#xConnector

Parameters

Name	Type
`value`	`any`[]

Returns

void

xLabel

• get xLabel(): number

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#xLabel

Returns

number

• set xLabel(value): void

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#xLabel

Parameters

Name	Type
`value`	`number`

Returns

void

yConnector

• get yConnector(): any[]

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#yConnector

Returns

any[]

• set yConnector(value): void

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#yConnector

Parameters

Name	Type
`value`	`any`[]

Returns

void

yLabel

• get yLabel(): number

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#yLabel

Returns

number

• set yLabel(value): void

Deprecated

since 4.0. Use getProperties instead.

Name

module:geotoolkit/schematics/labeling/LabelData~LabelData#yLabel

Parameters

Name	Type
`value`	`number`

Returns

void

Methods

getClassName

▸ getClassName(): string

Returns

string

getProperties

▸ getProperties(): Required<Options>

Returns

Required<Options>

options to initialize the strategy

setProperties

▸ setProperties(properties?): LabelData

Parameters

Name	Type	Description
`Optional` `properties`	`Options`	options to initialize the strategy

Returns

LabelData

getClassName

▸ Static getClassName(): string

Returns

string

Class: LabelData

Table of contents

Contents

new LabelData(params)

Parameters

anchorType

Returns

Parameters

Returns

node

Returns

Parameters

Returns

nodeInfo

Returns

Parameters

Returns

xConnector

Returns

Parameters

Returns

xLabel

Returns

Parameters

Returns

yConnector

Returns

Parameters

Returns

yLabel

Returns

Parameters

Returns

getClassName

Returns

getProperties

Returns

setProperties

Parameters

Returns

getClassName

Returns

Was this helpful?