API Reference
LabelPlacementRequest
A measured label with an anchor, priority and ordered candidate positions.
Inheritance
- Object
- LabelPlacementRequest
Usage
Explore 2 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
- Property PlacedLabel.Request
Accepted by parameters 1
- Method LabelPlacementService.Place
Constructors
public LabelPlacementRequest(String text, ChartPoint anchor, TextStyle style, IReadOnlyList<LabelCandidate> candidates, Int32 priority = 0) #Creates a placement request. Higher priorities are placed first; equal priorities retain input order.
Parameters
- text System.String
- anchor ChartForgeX.Primitives.ChartPoint
- style ChartForgeX.Typography.TextStyle
- candidates System.Collections.Generic.IReadOnlyList<ChartForgeX.Rendering.LabelCandidate>
- priority System.Int32 = 0
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String Text { get; } #Gets the original text, retained even when its visible label is shortened or dropped.
public ChartPoint Anchor { get; } #Gets the anchor in logical pixels.
public TextStyle Style { get; } #Gets the resolved text style.
public IReadOnlyList<LabelCandidate> Candidates { get; } #Gets candidates in preference order.
public Int32 Priority { get; } #Gets placement priority.
public LabelFallbackRule Fallback { get; set; } #Gets or sets the fallback rule.
public Boolean HasLeaderLine { get; set; } #Gets or sets whether a displaced label should have a leader from its anchor.
public String? AssociatedMarkId { get; set; } #Gets or sets the associated mark identity. A label fully contained in that mark is intentional; all other intersections are rejected.
public ChartRect? Bounds { get; set; } #Gets or sets optional bounds restricting this label, in addition to the scene bounds.
public Double Padding { get; set; } #Gets or sets padding around text, such as its halo or badge inset, in logical pixels.