Interface EncodingSpec

interface EncodingSpec {
    edge: {
        color?: ChannelEncoding<ColorScale>;
        label?: { driver: string };
        width?: ChannelEncoding<SizeScale>;
    };
    node: {
        color?: ChannelEncoding<ColorScale>;
        icon?: ChannelEncoding<IconScale>;
        label?: ChannelEncoding<FixedScale<string>> | { driver: string };
        shape?: ChannelEncoding<ShapeScale>;
        size?: ChannelEncoding<SizeScale>;
    };
    version: 1;
}

Index

Properties

edge node version

Properties

edge

edge: {
    color?: ChannelEncoding<ColorScale>;
    label?: { driver: string };
    width?: ChannelEncoding<SizeScale>;
}

Type Declaration

Optionalcolor?: ChannelEncoding<ColorScale>
Optionallabel?: { driver: string }
Same contract as node.label: overrides the converter's default (the edge type); dropping it restores that default, and hiding edge labels is a stylesheet rule, not a spec change.
Optionalwidth?: ChannelEncoding<SizeScale>

node

node: {
    color?: ChannelEncoding<ColorScale>;
    icon?: ChannelEncoding<IconScale>;
    label?: ChannelEncoding<FixedScale<string>> | { driver: string };
    shape?: ChannelEncoding<ShapeScale>;
    size?: ChannelEncoding<SizeScale>;
}

Type Declaration

Optionalcolor?: ChannelEncoding<ColorScale>
Optionalicon?: ChannelEncoding<IconScale>
Optionallabel?: ChannelEncoding<FixedScale<string>> | { driver: string }
OVERRIDES the label the canvas converter stamps on every node (properties.name, else the id); it never creates or removes one. Dropping the channel restores that default rather than hiding the label; a host that wants NO label adds a stylesheet rule ({ selector: "node", style: { label: "" } }).
Optionalshape?: ChannelEncoding<ShapeScale>
Optionalsize?: ChannelEncoding<SizeScale>

version

version: 1