pivotick - v1.5.0
    Preparing search index...

    Interface NodeStyle

    interface NodeStyle {
        color: string | ((node: Node) => string);
        fontFamily: string;
        html?: (node: Node) => string | void | HTMLElement;
        iconClass?: string;
        iconUnicode?: string;
        imageFit?: ((node: Node) => ImageFit) | ImageFit;
        imagePath?: string;
        shape: ((node: Node) => NodeShape) | NodeShape;
        size: number | ((node: Node) => number);
        strokeColor: string | ((node: Node) => string);
        strokeWidth: string | number;
        styleCb?: (node: Node) => Partial<NodeStyle>;
        svgIcon?: string;
        text?: string | ((node: Node) => string);
        textAnchorPosition: "end" | "start" | "middle";
        textColor: string | ((node: Node) => string);
        textHorizontalShift: number | ((node: Node) => number);
        textRotateDegree: number | ((node: Node) => number);
        textVerticalShift: number | ((node: Node) => number);
    }
    Index

    Properties

    color fontFamily html? iconClass? iconUnicode? imageFit? imagePath? shape size strokeColor strokeWidth styleCb? svgIcon? text? textAnchorPosition textColor textHorizontalShift textRotateDegree textVerticalShift

    Properties

    color: string | ((node: Node) => string)

    The main color of the node

    'var(--pvt-node-color, #007acc)'
    fontFamily: string
    'var(--pvt-label-font, system-ui, sans-serif)'
    html?: (node: Node) => string | void | HTMLElement

    The html to be used inside the node as an SVGForeignObject element

    Trusted HTML only. Whatever this returns is inserted as-is, so build it with textContent (or escape it) rather than interpolating node data into a markup string.

    iconClass?: string
    iconUnicode?: string
    imageFit?: ((node: Node) => ImageFit) | ImageFit

    How an imagePath picture sits on the node's shape. Resolvable per node so different nodes can mix modes (e.g. screenshots 'cover', other attachments 'icon').

    'icon'
    imagePath?: string

    URL of a picture to draw on the node. Restricted to the http:, https:, data: and blob: schemes; anything else is ignored. Rendering it fetches the URL.

    shape: ((node: Node) => NodeShape) | NodeShape

    The shape of the node, either a standard shape or a custom SVG path

    circle
    size: number | ((node: Node) => number)
    10
    strokeColor: string | ((node: Node) => string)
    'var(--pvt-node-stroke, #fff)'
    strokeWidth: string | number
    'var(--pvt-node-stroke-width, 2)'
    styleCb?: (node: Node) => Partial<NodeStyle>

    Callback to dynamically override style properties based on the node.

    svgIcon?: string

    Inline SVG markup drawn inside the node. Sanitized before it reaches the DOM (scripting and event handlers are stripped), but a remote <image href> inside it is still fetched when the node renders — see the security guide.

    Optionaltext

    text?: string | ((node: Node) => string)

    The text to be used inside the node as an SVGText element

    textAnchorPosition: "end" | "start" | "middle"
    'middle'
    textColor: string | ((node: Node) => string)
    'var(--pvt-node-text-color, #fff)'
    textHorizontalShift: number | ((node: Node) => number)

    The horizontal shift applied to the node's label position. A value of 0 means it is centered to the node, a value of 1 is east of the node, -1 is west of the node. Other values are also accepted, e.g., 0.5 would be halfway between the center and the east of the node.

    0
    textRotateDegree: number | ((node: Node) => number)

    Rotation degree applied to the node's label. Positive values rotate clockwise, negative values rotate counter-clockwise.

    0
    textVerticalShift: number | ((node: Node) => number)

    The vertical shift applied to the node's label position. A value of 0 means it is centered to the node, a value of 1 is north of the node, -1 is south of the node. Other values are also accepted, e.g., 0.5 would be halfway between the center and the north of the node.

    0

    Settings

    Member Visibility

    On This Page

    Properties