API / geotoolkit / schematics / labeling / XYLabelingStrategy / XYLabelingStrategy
labeling.XYLabelingStrategy.XYLabelingStrategy
Labeling strategy implementation based on XY layout and LocationType enum.
↳
XYLabelingStrategy
Constructors
Accessors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
anchorvaluefixed | boolean | Anchor fixed position flag |
anchorvalueshiftmult | number | Anchor value shift multiplier |
columns | number | Number of columns |
connectorlocation | ConnectorLocationType | Connector location along trajectory |
connectorshape | ConnectorShape | Connector shape |
connectorshape-labeldata | LabelData | |
connectorshape-labeldata-anchortype | AnchorType | Anchor type |
connectorshape-labeldata-node | ComponentNode | Component node to label |
connectorshape-labeldata-node-automodellimitsmode | boolean | Auto model limits mode |
connectorshape-labeldata-node-bounds | Rect | Define position of the group in the parent |
connectorshape-labeldata-node-bounds-height | number | Height |
connectorshape-labeldata-node-bounds-readonly | boolean | Readonly |
connectorshape-labeldata-node-bounds-width | number | Width |
connectorshape-labeldata-node-bounds-x | number | Left |
connectorshape-labeldata-node-bounds-y | number | Top |
connectorshape-labeldata-node-clipping | boolean | Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping |
connectorshape-labeldata-node-clipstyle | ClipStyle | Clipping style |
connectorshape-labeldata-node-clipstyle-evenodd | boolean | True if evenodd mode is on ('nonzero' mode otherwise) |
connectorshape-labeldata-node-clipstyle-geometry | GraphicsPath | Clipping geometry |
connectorshape-labeldata-node-clipstyle-geometry-bounds | Rect | Bounds |
connectorshape-labeldata-node-clipstyle | GraphicsPath | Clipping style |
connectorshape-labeldata-node-contentorientation | Orientation | Content orientation |
connectorshape-labeldata-node-cssclass | string | The css class name of this node |
connectorshape-labeldata-node-csscursor | string | CSS cursor associated with node |
connectorshape-labeldata-node-cssstyle | string | CSS style to be applied to inserted elements |
connectorshape-labeldata-node-description | string | Element description |
connectorshape-labeldata-node-fillstyle | string | Fill style |
connectorshape-labeldata-node-fillstyle | FillStyle | Fill style |
connectorshape-labeldata-node-fillstyle-color | string | Color in CSS form |
connectorshape-labeldata-node-fillstyle-evenoddmode | boolean | Even-odd fill mode |
connectorshape-labeldata-node-fillstyle-fillpattern | Pattern | Pattern |
connectorshape-labeldata-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 |
connectorshape-labeldata-node-fillstyle-fillpattern-patternname | string | Name of this pattern for indexing |
connectorshape-labeldata-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) |
connectorshape-labeldata-node-fillstyle-foreground | string | Foreground color |
connectorshape-labeldata-node-fillstyle-pattern | Pattern | Pattern |
connectorshape-labeldata-node-horizontalflip | boolean | Horizontal axis goes from right to left |
connectorshape-labeldata-node-id | string | number | Id of the node, its a unique identifier |
connectorshape-labeldata-node-infinity | boolean | Mode to render outside the model limits |
connectorshape-labeldata-node-layoutstyle | LayoutStyle | Layout style to be used for parent layout |
connectorshape-labeldata-node-layoutstyle-constraint | SizeConstraint | Layout constrains |
connectorshape-labeldata-node-layoutstyle-flexgrow | number | Number specifying how much the item will grow relative to the rest of the items inside the same container |
connectorshape-labeldata-node-layoutstyle-flexshrink | number | Number specifying how much the item will shrink relative to the rest of the items inside the same container |
connectorshape-labeldata-node-layoutstyle-float | string | Float position |
connectorshape-labeldata-node-layoutstyle-position | string | Layout position |
connectorshape-labeldata-node-layoutstyle-size | number | string | Layout size |
connectorshape-labeldata-node-linestyle | string | Line style |
connectorshape-labeldata-node-linestyle | LineStyle | Line style |
connectorshape-labeldata-node-linestyle-color | string | Color in CSS form |
connectorshape-labeldata-node-linestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
connectorshape-labeldata-node-linestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
connectorshape-labeldata-node-linestyle-linecap | CapStyle | The line cap style |
connectorshape-labeldata-node-linestyle-linedashoffset | number | Line dash offset of dashed line |
connectorshape-labeldata-node-linestyle-linejoin | JoinStyle | The line join style |
connectorshape-labeldata-node-linestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
connectorshape-labeldata-node-linestyle-scalable | boolean | True if width should depend on transformation |
connectorshape-labeldata-node-linestyle-unit | string | Optional unit for the width |
connectorshape-labeldata-node-linestyle-width | number | string | The line thickness |
connectorshape-labeldata-node-localtransform | Transformation | Local transformation |
connectorshape-labeldata-node-localtransform-dx | number | X axis translation |
connectorshape-labeldata-node-localtransform-dy | number | Y axis translation |
connectorshape-labeldata-node-localtransform-xx | number | X scale |
connectorshape-labeldata-node-localtransform-xy | number | Xy skew |
connectorshape-labeldata-node-localtransform-yx | number | Yx skew |
connectorshape-labeldata-node-localtransform-yy | number | Y scale |
connectorshape-labeldata-node-margins | number | string | It has properties for specifying the margins for each side |
connectorshape-labeldata-node-modellimits | Rect | Define inner model coordinates of the group |
connectorshape-labeldata-node-name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
connectorshape-labeldata-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 |
connectorshape-labeldata-node-opacityblendmode | BlendMode | Node opacity mode to blend it |
connectorshape-labeldata-node-padding | number | string | It has properties for specifying the padding for each side |
connectorshape-labeldata-node-pickingchildren | boolean | Enable picking children |
connectorshape-labeldata-node-rectbounds | Rect | Geometry bounds |
connectorshape-labeldata-node-scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
connectorshape-labeldata-node-scalescrollstrategy-enabled | boolean | Enable flag |
connectorshape-labeldata-node-selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
connectorshape-labeldata-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 |
connectorshape-labeldata-node-transform | string | Additional CSS transformation applied to node or 'none' |
connectorshape-labeldata-node-transform | Transformation | Additional CSS transformation applied to node or 'none' |
connectorshape-labeldata-node-verticalflip | boolean | Vertical axis goes from bottom to top |
connectorshape-labeldata-node-viewcache | boolean | View cache to cache child nodes |
connectorshape-labeldata-node-visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
connectorshape-labeldata-node-z-index | number | Define node z-index |
connectorshape-labeldata-nodeindex | number | The node virtual index |
connectorshape-labeldata-nodeinfo | string | The node information |
connectorshape-labeldata-xlabel | number | Label x-position |
connectorshape-labeldata-ylabel | number | Label y-position |
connectorshape-linestyle | string | |
connectorshape-linestyle | LineStyle | |
connectorshape-visible | boolean | |
connectorShape | ConnectorShape | Connector shape |
defaultalignment | AlignmentType | Alignment type |
defaultlocation | LocationType | |
deltapx | number | DeltaPx |
equallyspaced | boolean | "equally spaced" flag |
labelalignment | AlignmentType | Label alignment |
labelshape | LabelShape | Label shape |
labelshape-clipstyle | ClipStyle | Clipping style |
labelshape-clipstyle | GraphicsPath | Clipping style |
labelshape-cssclass | string | The css class name of this node |
labelshape-csscursor | string | CSS cursor associated with node |
labelshape-cssstyle | string | CSS style to be applied to inserted elements |
labelshape-fillstyle | string | Style applied on fill |
labelshape-fillstyle | FillStyle | Style applied on fill |
labelshape-id | string | number | Id of the node, its a unique identifier |
labelshape-linestyle | string | Style applied on outline |
labelshape-linestyle | LineStyle | Style applied on outline |
labelshape-localtransform | Transformation | Local transformation |
labelshape-margins | number | string | It has properties for specifying the margins for each side |
labelshape-name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
labelshape-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 |
labelshape-opacityblendmode | BlendMode | Node opacity mode to blend it |
labelshape-scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
labelshape-selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
labelshape-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 |
labelshape-textstyle | string | Label shape textstyle |
labelshape-textstyle | TextStyle | Label shape textstyle |
labelshape-textstyle-alignment | AlignmentStyle | Alignment |
labelshape-textstyle-autosize | boolean | Auto font size on high definition display |
labelshape-textstyle-background | string | Background style |
labelshape-textstyle-background | FillStyle | Background style |
labelshape-textstyle-baseline | BaseLineStyle | Base line |
labelshape-textstyle-color | string | Color in CSS form |
labelshape-textstyle-fill | FillStyle | Text fill style |
labelshape-textstyle-font | string | Font see |
labelshape-textstyle-fonturl | string | The place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword |
labelshape-textstyle-lineheight | string | number | Line height |
labelshape-textstyle-multiline | boolean | Allow multi-line text |
labelshape-textstyle-outline | string | Outline style |
labelshape-textstyle-outline | LineStyle | Outline style |
labelshape-textstyle-overflowwrap | OverflowWrapStyle | Overflow wrap |
labelshape-textstyle-strikethrough | string | Strikethrough style |
labelshape-textstyle-strikethrough | LineStyle | Strikethrough style |
labelshape-textstyle-textoverflow | TextOverflowStyle | Text overflow |
labelshape-textstyle-underline | string | Underline style |
labelshape-textstyle-underline | LineStyle | Underline style |
labelshape-textstyle-underlineoffset | string | number | Underline offset distance |
labelshape-textstyle-whitespace | WhiteSpaceStyle | White space |
labelshape-textstyle-wordbreak | WordBreakStyle | Word break |
labelshape-transform | string | Additional CSS transformation applied to node or 'none' |
labelshape-transform | Transformation | Additional CSS transformation applied to node or 'none' |
labelshape-visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
labelshape-z-index | number | Define node z-index |
labelShape | LabelShape | Label shape |
labelshapehighlighted | LabelShape | Highlighted label shape |
mode | Mode | Labeling mode |
Constructors
• new XYLabelingStrategy(options?)
| Name | Type |
|---|---|
Optional options | Options |
DefaultLabelingStrategy.constructor
Accessors
• Static get DefaultColumnNumber(): number
Default column number is 3
number
Methods
▸ Protected calculateLabelAnchorType(locationType, isHorizontal?): AnchorType
| Name | Type | Description |
|---|---|---|
locationType | LocationType | location type |
Optional isHorizontal | boolean | horizontal flag |
DefaultLabelingStrategy.calculateLabelAnchorType
▸ doLabeling(context, wellBoreNode, options?): LabelData[]
Performs labels and connecting lines layout.
| Name | Type | Description |
|---|---|---|
context | RenderingContext | rendering context |
wellBoreNode | WellBoreNode | well bore node to build the labeling of |
Optional options | DoLabelingOptions & Options & { componentsfilter?: IComponentsFilter ; connectorlocation?: ConnectorLocationType ; defaultalignment?: AlignmentType ; labelinfo?: Function ; mode?: Mode } & { anchorvaluefixed?: boolean ; deltapx?: number ; equallyspaced?: boolean } & { anchorvalueshiftmult?: number ; columns?: number ; labelalignment?: AlignmentType } | options |
an array of label data to render
DefaultLabelingStrategy.doLabeling
▸ Protected getActiveComponentsArea(): Rect
DefaultLabelingStrategy.getActiveComponentsArea
▸ getClassName(): string
string
DefaultLabelingStrategy.getClassName
▸ getLabelsBounds(location): Rect
Gets labeling area(s) bounds
| Name | Type | Description |
|---|---|---|
location | "Left" | "Top" | "Right" | "Bottom" | permitted values: "Left", "Right", "Top" or "Bottom" |
DefaultLabelingStrategy.getLabelsBounds
▸ getLayoutColumnNumber(): number
Gets layout column number
number
layout column number
▸ getLegendMode(): boolean
Gets legend mode
Deprecated
since 4.0. Use WellBoreWithLabels with 'nextlabel' instead.
boolean
DefaultLabelingStrategy.getLegendMode
▸ getOptions(): Required<Options>
Returns strategy options
Required<Options>
options
DefaultLabelingStrategy.getOptions
▸ getProperties(): Required<Options>
Returns properties
Required<Options>
strategy options
DefaultLabelingStrategy.getProperties
▸ setActiveComponentsArea(activeComponentsArea): XYLabelingStrategy
| Name | Type |
|---|---|
activeComponentsArea | Rect |
DefaultLabelingStrategy.setActiveComponentsArea
▸ setLabelsBounds(bounds): XYLabelingStrategy
Sets labeling area(s) bounds
| Name | Type | Description |
|---|---|---|
bounds | Partial<Record<"Left" | "Top" | "Right" | "Bottom", Rect>> | labeling area bounds |
this
DefaultLabelingStrategy.setLabelsBounds
▸ setLayoutColumnNumber(layoutColumnNumber): XYLabelingStrategy
Sets layout column number. Valid values: 1 (no horizontal layout), 2 or 3.
Throws
if layoutColumnNumber is invalid
| Name | Type | Description |
|---|---|---|
layoutColumnNumber | number | layout column number. Valid values: 1 (no horizontal layout), 2 or 3. Default value: 3. |
this
▸ setLegendMode(mode): XYLabelingStrategy
Sets legend mode
Deprecated
since 4.0. Use WellBoreWithLabels with 'nextlabel' instead.
| Name | Type | Description |
|---|---|---|
mode | boolean | mode |
DefaultLabelingStrategy.setLegendMode
▸ setOptions(options): XYLabelingStrategy
Sets strategy options (See base class method API for more options)
| Name | Type | Description |
|---|---|---|
options | Options | strategy options |
this
DefaultLabelingStrategy.setOptions
▸ setProperties(properties?): XYLabelingStrategy
Sets properties
| Name | Type | Description |
|---|---|---|
Optional properties | Options | strategy options |
this
DefaultLabelingStrategy.setProperties
▸ Static getClassName(): string
string