Type Alias VertexParameters

VertexParameters: {
    geometryClass?: typeof Geometry;
    height?: number;
    id?: string;
    parent?: Cell | null;
    position?: [number, number];
    relative?: boolean;
    size?: [number, number];
    style?: CellStyle;
    value?: any;
    width?: number;
    x?: number;
    y?: number;
}

Type declaration

  • OptionalgeometryClass?: typeof Geometry

    Class reference to a class derived from Geometry. This can be useful for defining custom constraints.

    Geometry

  • Optionalheight?: number

    It is mandatory to set this value or the size property.

  • Optionalid?: string

    Optional string that defines the id of the new vertex. If not set, the id is auto-generated when creating the vertex.

  • Optionalparent?: Cell | null

    The parent of the new vertex. If not set, use the default parent.

  • Optionalposition?: [number, number]

    Fallback when the x or the y properties are not set. Order of the elements: x, y

    NOTE: If the position of the vertex is not set at vertex creation (by setting the x or the y properties or this property), it is advised to use a GraphLayout or a LayoutManager to automatically compute the actual position.

  • Optionalrelative?: boolean

    Specifies if the geometry is relative.

    false
    
  • Optionalsize?: [number, number]

    Fallback when the width or the height properties are not set. Order of the elements: width, height

    NOTE: If the size of the vertex is not set at vertex creation (by setting the width and the height properties or this property), it is advised to later set the size on the geometry of the vertex instance. Otherwise, the vertex has no size and it is not displayed.

  • Optionalstyle?: CellStyle
  • Optionalvalue?: any

    Object to be used as the user object which is generally used to display the label of the vertex. The default implementation handles string object.

  • Optionalwidth?: number

    It is mandatory to set this value or the size property.

  • Optionalx?: number

    It is mandatory to set this value or the position property.

  • Optionaly?: number

    It is mandatory to set this value or the position property.