C

StripeLabelModel

Show Usages
A label model for stripe labels which supports the possible header positions of IRows and IColumns.
ImplementsInheritance Hierarchy

Remarks

This label model supports four positions inside the stripe bounds. The left and right positions are rotated automatically. ILabelModelParameters created by this model support only IStripe instances as label owner.

It uses the label's preferredSize for the size of the label layout.

See Also

Developer's Guide

Members

No filters for this type

Constructors

StripeLabelModel

()
Creates a new instance of this model with zero padding.

Parameters

Properties

ratio

: number
Gets or sets the ratio of how far the label should be positioned from the border in the header area.
0 means the label is positioned on the outer border, 1 means it is positioned at the inner border of the header or inset area. Default value is 0.5.

useTotalPadding

: boolean
Gets or sets a value indicating whether to use the global padding or the normal padding of a stripe for centering the label inside the stripe header area.
If true the header padding is used. Default is false

Methods

createParameter

(position: StripeLabelModelPosition): StripeLabelModelParameter
Creates the parameter for the given position.

Parameters

position: StripeLabelModelPosition
The position.

Return Value

StripeLabelModelParameter
The parameter for the given position.

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 in the form of an IOrientedRectangle for a given label using the given model parameter.
The geometry is calculated in table coordinates, i.e. relative to the upper left corner of the table.
final

Parameters

label: ILabel
the label to calculate the geometry for
layoutParameter: ILabelModelParameter
A parameter that has been created by this model. This is typically the parameter that yielded this instance through its model property.

Return Value

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

Constants

BOTTOM

: StripeLabelModelParameter
static
A predefined parameter instance that places a label inside the bottom header of a column.
This parameter instance's model is immutable. Trying to change its ratio or useTotalPadding properties will raise an InvalidOperationError.
static

Sample Graphs

LEFT

: StripeLabelModelParameter
static
A predefined parameter instance that places a label inside the left header of a row.
This parameter instance's model is immutable. Trying to change its ratio or useTotalPadding properties will raise an InvalidOperationError.
static

Sample Graphs

RIGHT

: StripeLabelModelParameter
static
A predefined parameter instance that places a label inside the right header of a row.
This parameter instance's model is immutable. Trying to change its ratio or useTotalPadding properties will raise an InvalidOperationError.
static

Sample Graphs

TOP

: StripeLabelModelParameter
static
A predefined parameter instance that places a label inside the top header of a column.
This parameter instance's model is immutable. Trying to change its ratio or useTotalPadding properties will raise an InvalidOperationError.
static

Sample Graphs