Interface ShapeComponentProps

Props for the ShapeComponent. At the minimum you should pass in the ctx that the Surface provides to the mapping in your viewOptions.

interface ShapeComponentProps {
    ctx: JsxWrapperProps<Vertex>;
    labelFillRatio?: number;
    labelProperty?: string;
    labelStrokeWidth?: string;
    multilineLabels?: boolean;
    showLabels?: boolean;
}

Properties

ctx labelFillRatio? labelProperty? labelStrokeWidth? multilineLabels? showLabels?

Properties

ctx

ctx: JsxWrapperProps<Vertex>

Context for the vertex, as passed in by the SurfaceComponent.

OptionallabelFillRatio

labelFillRatio?: number

For multiline labels, the proportion of the width of the shape that the longest line can take up.

OptionallabelProperty

labelProperty?: string

The name of the property that identifies some vertex's label. Defaults to "label".

OptionallabelStrokeWidth

labelStrokeWidth?: string

Optional stroke width to use for labels. Defaults to "0.25px".

OptionalmultilineLabels

multilineLabels?: boolean

Defaults to true - word wrap shape labels so they fit into their shapes

OptionalshowLabels

showLabels?: boolean

Defaults to false. If true, a label will be written on the shape (using an SVG text element).

Settings

Member Visibility

On This Page

Properties
Version :