C

CompositeLabelStyle

Show Usages
A foundational implementation of ILabelStyle that delegates its behavior to several style instances.

Remarks

This class can be used to combine multiple SVG-based style instances into one.

The following aspects will be delegated to all instances:

The following aspects will be delegated to the first/main style, only:

This class can be subclassed like LabelStyleBase<TVisual> to allow for custom implementations of the various aspects of the delegation.

See Also

Developer's Guide

Members

Show:

Constructors

CompositeLabelStyle

(mainStyle: ILabelStyle, additionalStyles: ILabelStyle)
Creates a new instance of this style.

Parameters

mainStyle: ILabelStyle
The main style which will be rendered first and to which all requests will delegate to.
additionalStyles: ILabelStyle
Additional styles which will be rendered on top and which will also be included in the hit-, visibility-, and bounds tests.

Properties

renderer

: ILabelStyleRenderer
readonly
Gets the renderer implementation for this instance.
The private implementation will delegate all API calls back to this instance.
readonlyfinal

styles

: IList<ILabelStyle>
readonly
Gets a readonly list of the styles used by this instance.
The first item is the main instance, and the others are the additional instances rendered on top in order. The list always has at least one member.
readonlyfinal

Methods

clone

(): Object
Returns a memberwise clone.
This will also clone the style instances.

Return Value

Object
A clone of this instance.

createVisual

(context: IRenderContext, label: ILabel): Visual
protected
Creates the visual by delegating to all styles.
This implementation puts all Visuals of the styles into a single compound SvgVisualGroup.
protected

Parameters

context: IRenderContext
The render context.
label: ILabel
The label to which this style instance is assigned.

Return Value

Visual
The visual as required by the createVisual interface.

See Also

API
updateVisual

getBounds

(context: ICanvasContext, label: ILabel): Rect
protected
Calculates the bounds as the union of bounds from all styles.
protected

Parameters

context: ICanvasContext
The canvas context.
label: ILabel
The label to which this style instance is assigned.

Return Value

Rect
The visual bounds of the visual representation.

getPreferredSize

(label: ILabel): Size
protected
Gets the size from the first style as the reference.
protected

Parameters

label: ILabel
The label.

Return Value

Size
The preferred size for this label.

isHit

(
context: IInputModeContext
location: Point
label: ILabel
): boolean
protected
Checks whether any style is hit at the given location.
protected

Parameters

context: IInputModeContext
The input mode context.
location: Point
The point to test.
label: ILabel
The label to which this style instance is assigned.

Return Value

boolean
true if the specified label is hit; false otherwise.

isInBox

(
context: IInputModeContext
rectangle: Rect
label: ILabel
): boolean
protected
Determines if the label is in the box based on any style.
protected

Parameters

context: IInputModeContext
The input mode context.
rectangle: Rect
The marquee selection box.
label: ILabel
The label to which this style instance is assigned.

Return Value

boolean
true if the specified label is visible and selected by the marquee rectangle; false otherwise.

isInPath

(
context: IInputModeContext
path: GeneralPath
label: ILabel
): boolean
protected
Determines if the label is in the path based on any style.
protected

Parameters

context: IInputModeContext
The input mode context.
path: GeneralPath
The lasso selection path.
label: ILabel
The label to which this style instance is assigned.

Return Value

boolean
true if the specified label is visible and selected by the lasso path; false otherwise.

isVisible

(
context: ICanvasContext
rectangle: Rect
label: ILabel
): boolean
protected
Determines visibility based on the visibility of all styles.
protected

Parameters

context: ICanvasContext
The canvas context.
rectangle: Rect
The clipping rectangle.
label: ILabel
The label to which this style instance is assigned.

Return Value

boolean
true if the specified label is visible in the clipping rectangle; false otherwise.

lookup

(label: ILabel, type: Constructor): any
protected
Performs a lookup using the first style as the reference.
protected

Parameters

label: ILabel
The label to use for the context lookup.
type: Constructor
The type to query.

Return Value

any
An implementation of the type or null.

updateVisual

(
context: IRenderContext
oldVisual: Visual
label: ILabel
): Visual
protected
Updates the visual by delegating to all styles.
This implementation updates all Visuals of the styles from a single compound SvgVisualGroup.
protected

Parameters

context: IRenderContext
The render context.
oldVisual: Visual
The visual that has been created in the call to createVisual.
label: ILabel
The label to which this style instance is assigned.

Return Value

Visual
The visual as required by the createVisual interface.

See Also

API
createVisual