C

FreeLabelModel

Show Usages
A label model that can be used to describe any position and orientation of a label.
ImplementsInheritance Hierarchy

Remarks

The position of the label is stored absolutely and is not influenced by the layout or position of the owner of the label. In fact, the owner is not even queried during a call to getGeometry.

See Also

Developer's Guide

Members

No filters for this type

Methods

createAbsolute

(anchorLocation: Point, angle?: number): AbsoluteFreeLabelModelParameter
Creates a new label model parameter that places the label at the given absolute position using the provided angle.
final

Parameters

anchorLocation: Point
The location for the parameter.
angle?: number
The angle of rotation. The default is 0.

Return Value

AbsoluteFreeLabelModelParameter
A new parameter that is associated with this instance.

createAnchored

(location: IPoint, angle?: number): AnchoredFreeLabelModelParameter
Creates a new label at the given dynamic location using the provided angle.
final

Parameters

location: IPoint
The location to place the parameter at. That instance is stored by reference.
angle?: number
The angle of rotation. The default is 0.

Return Value

AnchoredFreeLabelModelParameter
A new parameter that is associated with this instance.

createDynamic

(layout: IOrientedRectangle): DynamicFreeLabelModelParameter
Creates a new label model parameter that dynamically reads the label layout from the provided instance.
final

Parameters

layout: IOrientedRectangle
The oriented rectangle to dynamically retrieve the values from.

Return Value

DynamicFreeLabelModelParameter
A new parameter that is associated with this instance.

getContext

(label: ILabel): ILookup
Provides a lookup context for the given label.

Parameters

label: ILabel
The label to use in the context.

Return Value

ILookup
An implementation of the ILookup interface that can be used to query additional aspects of the label.

getGeometry

(label: ILabel, layoutParameter: ILabelModelParameter): IOrientedRectangle
Calculates the geometry of the given label using the given model parameter.
final

Parameters

label: ILabel
The label to calculate the geometry for.
layoutParameter: ILabelModelParameter
A parameter that is compatible with this model. Typically, this is a parameter that has been created by this model, and its property model returns this instance.

Return Value

IOrientedRectangle
An IOrientedRectangle that describes the geometry of the label. This is typically designed as a flyweight, therefore clients should not cache the instance but store the values if they need a snapshot for later use.

Constants

INSTANCE

: FreeLabelModel
static
A shared public instance that can be used to obtain parameters.