IPluginSettings

`w`

[ int, required ]

Width of the expand panel.

`h`

[ int, required ]

Height of the expand panel.

`nodeConstraint`

[ NodeConstraints | None, default: None ]

Specify when the plugin will be shown.

If set to none, the plugin will always be shown.
If set to anyNode, the plugin will be shown when any node is selected.
If set to singleNode, the plugin will be shown when only one node is selected.
If set to multiNode, the plugin will be shown when more than one node is selected.
Otherwise, the plugin will be shown when the selected node is of the specified type.

cfdraw/parsers/noli.py
class NodeConstraints(str, Enum):
    # single node
    SVG = "svg"
    TEXT = "text"
    IMAGE = "image"
    PATH = "path"
    NOLI_FRAME = "noliFrame"
    NOLI_TEXT_FRAME = "noliTextFrame"
    # group
    GROUP = "group"
    # special
    NONE = "none"
    ANY_NODE = "anyNode"
    SINGLE_NODE = "singleNode"
    MULTI_NODE = "multiNode"

`nodeConstraintRules`

[ NodeConstraintRules | None, default: None ]

Specify the complex rule of the node constraint.

Will work together with nodeConstraint, but it is often not necessary to use nodeConstraint when this field is set.

`NodeConstraintRules`

some
[ List[NodeConstraints] | None, default: None ]
Some of the constraints must be satisfied.
every
[ NodeConstraints] | None, default: None ]
Every constraint must be satisfied.
exactly
[ NodeConstraints] | None, default: None ]
The exact constraints. This is useful when we want to constrain certain number of nodes as well as their types.

`nodeConstraintValidator`

[ str | None, default: None ]

The universal fallback.

It specifies the name of the validator registered by register_node_validator. This is used when the nodeConstraint and nodeConstraintRules cannot represent the desired constraint.

For example, if we want to display the plugin only if the selected Node is a Text and its text is "Hello World", we can do the following:

app.py
@register_node_validator("hello_world")
def validate_variation(data: ISocketRequest) -> bool:
    if data.nodeData.type != SingleNodeType.TEXT:
        return False
    return data.nodeData.text == "Hello World"


class Plugin(IFieldsPlugin):
    @property
    def settings(self) -> IPluginSettings:
        return IPluginSettings(
            ...,
            nodeConstraintValidator="hello_world",
        )

info

Check here for the API reference of SingleNodeType.

`src`

[ str | None, default: None ]

The image url that will be shown for the plugin.

If not specified, we will use a default plugin-ish image.

`tooltip`

[ str | None, default: None ]

The tooltip that will be shown for the plugin.

It is recommended to specify an informative tooltip, but it's also OK to leave it as None, in which case we will not show any tooltip for the plugin.

`pivot`

[ PivotType | None, default: None ]

Pivot of the plugin.

If follow is set to true, the plugin will be shown at the pivot of the selected node.
Otherwise, the plugin will be shown at the pivot of the entire drawboard 🎨.

cftool.geometry
class PivotType(str, Enum):
    LT = "lt"
    TOP = "top"
    RT = "rt"
    LEFT = "left"
    CENTER = "center"
    RIGHT = "right"
    LB = "lb"
    BOTTOM = "bottom"
    RB = "rb"

info

See Pivot for more details.