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 parameters are not set. It is mandatory to set this value or the x and the y properties. Order of the elements: x, y

  • Optionalrelative?: boolean

    Specifies if the geometry is relative.

    false
    
  • Optionalsize?: [number, number]

    Fallback when the width or the height parameters are not set. It is mandatory to set this value or the width and the height properties. Order of the elements: width, height

  • 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.