@syncfusion/ej2-diagrams
Version:
Feature-rich diagram control to create diagrams like flow charts, organizational charts, mind maps, and BPMN diagrams. Its rich feature set includes built-in shapes, editing, serializing, exporting, printing, overview, data binding, and automatic layouts.
1,365 lines • 108 kB
TypeScript
/**
* enum module defines the public enumerations
*/
/**
* @private
*/
export declare enum BlazorAction {
/** Return the layout value is true when doLayout is called */
Default = 0,
/** Need to return the layout value when doLayout is called */
expandNode = 2,
/** Enabled during the mouse interaction */
interaction = 4,
/** Enable when the group action start in history */
GroupingInProgress = 8,
/** Enable when the group action start to clone another group node */
GroupClipboardInProcess = 16,
/** Enable when the clear the object to prevent the server update */
ClearObject = 32
}
/**
* Defines how the diagram elements have to be aligned with respect to its immediate parent
* * Stretch - Stretches the diagram element throughout its immediate parent
* * Left - Aligns the diagram element at the left of its immediate parent
* * Right - Aligns the diagram element at the right of its immediate parent
* * Center - Aligns the diagram element at the center of its immediate parent
* * Auto - Aligns the diagram element based on the characteristics of its immediate parent
*/
export declare type HorizontalAlignment =
/**
* Stretch - Stretches the diagram element throughout its immediate parent
*/
'Stretch' |
/**
* Left - Aligns the diagram element at the left of its immediate parent
*/
'Left' |
/**
* Right - Aligns the diagram element at the right of its immediate parent
*/
'Right' |
/**
* Center - Aligns the diagram element at the center of its immediate parent
*/
'Center' |
/**
* Auto - Aligns the diagram element based on the characteristics of its immediate parent
*/
'Auto';
/**
* Defines how the diagram elements have to be aligned with respect to its immediate parent
* * Stretch - Stretches the diagram element throughout its immediate parent
* * Top - Aligns the diagram element at the top of its immediate parent
* * Bottom - Aligns the diagram element at the bottom of its immediate parent
* * Center - Aligns the diagram element at the center of its immediate parent
* * Auto - Aligns the diagram element based on the characteristics of its immediate parent
*/
export declare type VerticalAlignment =
/**
* Stretch - Stretches the diagram element throughout its immediate parent
*/
'Stretch' |
/**
* Top - Aligns the diagram element at the top of its immediate parent
*/
'Top' |
/**
* Bottom - Aligns the diagram element at the bottom of its immediate parent
*/
'Bottom' |
/**
* Center - Aligns the diagram element at the center of its immediate parent
*/
'Center' |
/**
* Auto - Aligns the diagram element based on the characteristics of its immediate parent
*/
'Auto';
/**
* Defines how the ports have to be aligned with respect to its immediate parent
* Center - Aligns the ports at the center of a connector segment
* Before - Aligns the ports before a connector segment
* After - Aligns the ports after a connector segment
*/
export declare type PortAlignment =
/**
* Center - Aligns the ports at the center of a connector segment
*/
'Center' |
/**
* Before - Aligns the ports before a connector segment
*/
'Before' |
/**
* After - Aligns the ports after a connector segment
*/
'After';
/**
* Defines how the diagram elements have to be flipped with respect to its immediate parent
* * FlipHorizontal - Translate the diagram element throughout its immediate parent
* * FlipVertical - Rotate the diagram element throughout its immediate parent
* * Both - Rotate and Translate the diagram element throughout its immediate parent
* * None - Set the flip Direction as None
*/
export declare enum FlipDirection {
/**
* FlipHorizontal - Translate the diagram element throughout its immediate parent
*/
Horizontal = 1,
/**
* FlipVertical - Rotate the diagram element throughout its immediate parent
*/
Vertical = 2,
/**
* Both - Rotate and Translate the diagram element throughout its immediate parent
*/
Both = 3,
/**
* None - Set the flip Direction as None
*/
None = 0
}
/**
* Allows you to flip only the node or along with port, label, labelText
* * All - Flips port, label and label text along with the node
* * Label - Flips the label along with the node and keeps the text readable
* * LabelText – Flips the node and inverts the label without flipping its position
* * Port - Flips port along with the node
* * None - Flips only the node
* * PortAndLabel – Flips the port and label along with the node
* * PortAndLabelText – Flips the port and label text along with the node
* * LabelAndLabelText – Flips the label and label text along with the node
*/
export declare type FlipMode =
/**
* All - Flips port, label and label text along with the node
*/
'All' |
/**
* Label - Flips the label along with the node and keeps the text readable.
*/
'Label' |
/**
* LabelText – Flips the node and inverts the label without flipping its position
*/
'LabelText' |
/**
* Port - Flips port along with the node
*/
'Port' |
/**
* None - Flips only the node
*/
'None' |
/**
* PortAndLabel – Flips the port and label along with the node
*/
'PortAndLabel' |
/**
* PortAndLabelText – Flips the port and label text along with the node
*/
'PortAndLabelText' |
/**
* LabelAndLabelText – Flips the label and label text along with the node
*/
'LabelAndLabelText';
/**
* Defines the orientation of the Page
* Landscape - Display with page Width is more than the page Height.
* Portrait - Display with page Height is more than the page width.
*/
export declare type PageOrientation =
/**
* Landscape - Display with page Width is more than the page Height
*/
'Landscape' |
/**
* Portrait - Display with page Height is more than the page width
*/
'Portrait';
/**
* Defines the orientation of the layout
* * TopToBottom - Renders the layout from top to bottom
* * BottomToTop - Renders the layout from bottom to top
* * LeftToRight - Renders the layout from left to right
* * RightToLeft - Renders the layout from right to left
*/
export declare type LayoutOrientation =
/**
* TopToBottom - Renders the layout from top to bottom
*/
'TopToBottom' |
/**
* BottomToTop - Renders the layout from bottom to top
*/
'BottomToTop' |
/**
* LeftToRight - Renders the layout from left to right
*/
'LeftToRight' |
/**
* RightToLeft - Renders the layout from right to left
*/
'RightToLeft' |
/**
* Horizontal - Renders only the mindmap layout from left to right
*/
'Horizontal' |
/**
* vertical - Renders only the mindmap layout from top to bottom
*/
'vertical';
/**
* Defines the types of the automatic layout
* * None - None of the layouts is applied
* * HierarchicalTree - Defines the type of the layout as Hierarchical Tree
* * OrganizationalChart - Defines the type of the layout as Organizational Chart
* * ComplexHierarchicalTree - Defines the type of the layout as complex HierarchicalTree
* * RadialTree - Defines the type of the layout as Radial tree
*/
export declare type LayoutType =
/**
* None - None of the layouts is applied
*/
'None' |
/**
* HierarchicalTree - Defines the type of the layout as Hierarchical Tree
*/
'HierarchicalTree' |
/**
* RadialTree - Defines the type of the layout as Radial Tree
*/
'RadialTree' |
/**
* OrganizationalChart - Defines the type of the layout as Organizational Chart
*/
'OrganizationalChart' |
/**
* SymmetricalLayout - Defines the type of the layout as SymmetricalLayout
*/
'SymmetricalLayout' |
/**
* ComplexHierarchicalTree - Defines the type of the layout as complex HierarchicalTree
*/
'ComplexHierarchicalTree' |
/**
* MindMap - Defines the type of the layout as MindMap
*/
'MindMap' |
/**
* Flowchart - Defines the type of the layout as Flowchart
*/
'Flowchart';
/**
* Defines the state of the layout rendering process.
* * Started - Indicates that the layout rendering process has started.
* * Completed - Indicates that the layout rendering process has finished.
*/
export declare type LayoutState =
/**
* Started - Indicates that the layout rendering process has started.
*/
'Started' |
/**
* Completed - Indicates that the layout rendering process has finished.
*/
'Completed';
export declare type BranchDirection =
/**
* SameAsFlow -Defines the direction as same as flow chart.
*/
'SameAsFlow' |
/**
* LeftInFlow - Defines the flow direction as left.
*/
'LeftInFlow' |
/**
* RightInFlow - Defines the flow direction as right.
*/
'RightInFlow';
/**
* Alignment position
* Left - Sets the branch type as Left
* Right - Sets the branch type as Right
* SubLeft - Sets the branch type as SubLeft
* SubRight - Sets the branch type as SubRight
* Root - Sets the branch type as Root
*/
export declare type BranchTypes =
/**
* Left - Sets the branch type as Left
*/
'Left' |
/**
* Right - Sets the branch type as Right
*/
'Right' |
/**
* SubLeft - Sets the branch type as SubLeft
*/
'SubLeft' |
/**
* SubRight - Sets the branch type as SubRight
*/
'SubRight' |
/**
* Root - Sets the branch type as Root
*/
'Root';
/**
* Defines how the first segments have to be defined in a layout
* Auto - Defines the first segment direction based on the type of the layout
* Orientation - Defines the first segment direction based on the orientation of the layout
* Custom - Defines the first segment direction dynamically by the user
*/
export declare type ConnectionDirection =
/**
* Auto - Defines the first segment direction based on the type of the layout
*/
'Auto' |
/**
* Orientation - Defines the first segment direction based on the orientation of the layout
*/
'Orientation' |
/**
* Custom - Defines the first segment direction dynamically by the user
*/
'Custom';
/**
* Defines where the user handles have to be aligned
* Top - Aligns the user handles at the top of an object
* Bottom - Aligns the user handles at the bottom of an object
* Left - Aligns the user handles at the left of an object
* Right - Aligns the user handles at the right of an object
*/
export declare type Side =
/**
* Top - Aligns the user handles at the top of an object
*/
'Top' |
/**
* Bottom - Aligns the user handles at the bottom of an object
*/
'Bottom' |
/**
* Left - Aligns the user handles at the left of an object
*/
'Left' |
/**
* Right - Aligns the user handles at the right of an object
*/
'Right';
/**
* Defines how the connectors have to be routed in a layout
* Default - Routes the connectors like a default diagram
* Layout - Routes the connectors based on the type of the layout
*/
export declare type ConnectorSegments =
/**
* Default - Routes the connectors like a default diagram
*/
'Default' |
/**
* Layout - Routes the connectors based on the type of the layout
*/
'Layout';
/**
* Defines how the annotations have to be aligned with respect to its immediate parent
* Center - Aligns the annotation at the center of a connector segment
* Before - Aligns the annotation before a connector segment
* After - Aligns the annotation after a connector segment
*/
export declare type AnnotationAlignment =
/**
* Center - Aligns the annotation at the center of a connector segment
*/
'Center' |
/**
* Before - Aligns the annotation before a connector segment
*/
'Before' |
/**
* After - Aligns the annotation after a connector segment
*/
'After';
/**
* Defines how the fixedUserHandle have to be aligned with respect to its immediate parent
* Center - Aligns the fixedUserHandle at the center of a connector segment
* Before - Aligns the fixedUserHandle before a connector segment
* After - Aligns the fixedUserHandle after a connector segment
*/
export declare type FixedUserHandleAlignment =
/**
* Center - Aligns the fixedUserHandle at the center of a connector segment
*/
'Center' |
/**
* Before - Aligns the fixedUserHandle before a connector segment
*/
'Before' |
/**
* After - Aligns the fixedUserHandle after a connector segment
*/
'After';
/**
* Defines the type of the port
* Point - Sets the type of the port as Point
* Path - Sets the type of the port as Path
* Dynamic - Sets the type of the port as Dynamic
*/
export declare type PortTypes =
/**
* Point - Sets the type of the port as Point
*/
'Point' |
/**
* Path - Sets the type of the port as Path
*/
'Path' |
/**
* Dynamic - Sets the type of the port as Dynamic
*/
'Dynamic';
/**
* Defines the type of the annotation
* Shape - Sets the annotation type as Shape
* Path - Sets the annotation type as Path
*/
export declare type AnnotationTypes =
/**
* Shape - Sets the annotation type as Shape
*/
'Shape' |
/**
* Path - Sets the annotation type as Path
*/
'Path';
/**
* File Format type for export.
* JPG - Save the file in JPG Format
* PNG - Saves the file in PNG Format
* BMP - Save the file in BMP Format
* SVG - save the file in SVG format
*
* @IgnoreSingular
*/
export declare type FileFormats =
/** JPG-Save the file in JPG Format */
'JPG' |
/** PNG - Save the file in PNG Format */
'PNG' |
/** BMP - Save the file in BMP format */
'BMP' |
/** SVG - Saves the file in SVG format */
'SVG';
/**
* Defines whether the diagram has to be exported as an image or it has to be converted as image url
* Download
* Data
*
* @IgnoreSingular
*/
export declare type ExportModes =
/** Download - Download the image */
'Download' |
/** Data - Converted as image url */
'Data';
/**
* Defines the child type to be added in the UmlClassifierShape.
* Methods
* Attributes
* Members
*
* @IgnoreSingular
*/
export declare type UmlClassChildType =
/** Methods - Specified the UML class/interface child type as Method. */
'Method' |
/** Attributes -Specified the UML class/interface child type as Method */
'Attribute' |
/** Members - Specified the UML enum child type as Method */
'Member';
/**
* Defines the region that has to be drawn as an image
* PageSettings - With the given page settings image has to be exported.
* Content - The diagram content is export
* CustomBounds - Exported with given bounds.
*
* @IgnoreSingular
*/
export declare type DiagramRegions =
/** PageSettings - With the given page settings image has to be exported. */
'PageSettings' |
/** Content - The diagram content is export */
'Content' |
/** CustomBounds - Exported with given bounds. */
'CustomBounds';
/**
* Defines the type of annotation template
* String - Defines annotation template to be in string
* Template - Defines annotation template to be in html content
*
* @IgnoreSingular
*/
export declare type AnnotationType =
/** String - Defines annotation template to be in string */
'String' |
/** Template - Defines annotation template to be in html content */
'Template';
/**
* Constraints to define when a port has to be visible
* Visible - Always shows the port
* Hidden - Always hides the port
* Hover - Shows the port when the mouse hovers over a node
* Connect - Shows the port when a connection end point is dragged over a node
* Default - By default the ports will be visible when a node is hovered and being tried to connect
*
* @aspNumberEnum
*/
export declare enum PortVisibility {
/** Always shows the port */
Visible = 1,
/** Always hides the port */
Hidden = 2,
/** Shows the port when the mouse hovers over a node */
Hover = 4,
/** Shows the port when a connection end point is dragged over a node */
Connect = 8
}
/**
* Define the allowed direction for connections to the port
* Auto - Maintains the default behavior of automatic direction calculation.
* Left - Restricts connections to only connect to the left side of the port.
* Top - Restricts connections to only connect to the top side of the port.
* Right - Restricts connections to only connect to the right side of the port.
* Bottom - Restricts connections to only connect to the bottom side of the port.
*
* @IgnoreSingular
*/
export declare type PortConnectionDirection =
/** Maintains the default behavior of automatic direction calculation.*/
'Auto' |
/** Restricts connections to only connect to the left side of the port. */
'Left' |
/** Restricts connections to only connect to the top side of the port */
'Top' |
/** Restricts connections to only connect to the right side of the port */
'Right' |
/** Restricts connections to only connect to the bottom side of the port */
'Bottom';
/**
* Defines the constraints to Enables / Disables some features of Snapping.
* None - Snapping does not happen
* ShowHorizontalLines - Displays only the horizontal gridlines in diagram.
* ShowVerticalLines - Displays only the Vertical gridlines in diagram.
* ShowLines - Display both Horizontal and Vertical gridlines.
* SnapToHorizontalLines - Enables the object to snap only with horizontal gridlines.
* SnapToVerticalLines - Enables the object to snap only with horizontal gridlines.
* SnapToLines - Enables the object to snap with both horizontal and Vertical gridlines.
* snapToObject - Enables the object to snap with the other objects in the diagram.
*
* @IgnoreSingular
* @aspNumberEnum
*/
export declare enum SnapConstraints {
/** None - Snapping does not happen */
None = 0,
/** ShowHorizontalLines - Displays only the horizontal gridlines in diagram. */
ShowHorizontalLines = 1,
/** ShowVerticalLines - Displays only the Vertical gridlines in diagram */
ShowVerticalLines = 2,
/** ShowLines - Display both Horizontal and Vertical gridlines */
ShowLines = 3,
/** SnapToHorizontalLines - Enables the object to snap only with horizontal gridlines */
SnapToHorizontalLines = 4,
/** SnapToVerticalLines - Enables the object to snap only with horizontal gridlines */
SnapToVerticalLines = 8,
/** SnapToLines - Enables the object to snap with both horizontal and Vertical gridlines */
SnapToLines = 12,
/** SnapToObject - Enables the object to snap with the other objects in the diagram. */
SnapToObject = 16,
/** Shows gridlines and enables snapping */
All = 31
}
/**
* Defines the visibility of the selector handles
* None - Hides all the selector elements
* ConnectorSourceThumb - Shows/hides the source thumb of the connector
* ConnectorTargetThumb - Shows/hides the target thumb of the connector
* ResizeSouthEast - Shows/hides the bottom right resize handle of the selector
* ResizeSouthWest - Shows/hides the bottom left resize handle of the selector
* ResizeNorthEast - Shows/hides the top right resize handle of the selector
* ResizeNorthWest - Shows/hides the top left resize handle of the selector
* ResizeEast - Shows/hides the middle right resize handle of the selector
* ResizeWest - Shows/hides the middle left resize handle of the selector
* ResizeSouth - Shows/hides the bottom center resize handle of the selector
* ResizeNorth - Shows/hides the top center resize handle of the selector
* Rotate - Shows/hides the rotate handle of the selector
* UserHandles - Shows/hides the user handles of the selector
* Resize - Shows/hides all resize handles of the selector
*
* @aspNumberEnum
* @IgnoreSingular
*/
export declare enum SelectorConstraints {
/** Hides all the selector elements */
None = 1,
/** Shows/hides the source thumb of the connector */
ConnectorSourceThumb = 2,
/** Shows/hides the target thumb of the connector */
ConnectorTargetThumb = 4,
/** Shows/hides the bottom right resize handle of the selector */
ResizeSouthEast = 8,
/** Shows/hides the bottom left resize handle of the selector */
ResizeSouthWest = 16,
/** Shows/hides the top right resize handle of the selector */
ResizeNorthEast = 32,
/** Shows/hides the top left resize handle of the selector */
ResizeNorthWest = 64,
/** Shows/hides the middle right resize handle of the selector */
ResizeEast = 128,
/** Shows/hides the middle left resize handle of the selector */
ResizeWest = 256,
/** Shows/hides the bottom center resize handle of the selector */
ResizeSouth = 512,
/** Shows/hides the top center resize handle of the selector */
ResizeNorth = 1024,
/** Shows/hides the rotate handle of the selector */
Rotate = 2048,
/** Shows/hides the user handles of the selector */
UserHandle = 4096,
/** Shows/hides the default tooltip of nodes and connectors */
ToolTip = 8192,
/** Shows/hides all resize handles of the selector */
ResizeAll = 2046,
/** Shows all handles of the selector */
All = 16382
}
/**
* Defines the type of the panel
* None - Defines that the panel will not rearrange its children. Instead, it will be positioned based on its children.
* Canvas - Defines the type of the panel as Canvas
* Stack - Defines the type of the panel as Stack
* Grid - Defines the type of the panel as Grid
* WrapPanel - Defines the type of the panel as WrapPanel
*/
export declare type Panels =
/** None - Defines that the panel will not rearrange its children. Instead, it will be positioned based on its children. */
'None' |
/** Canvas - Defines the type of the panel as Canvas */
'Canvas' |
/** Stack - Defines the type of the panel as Stack */
'Stack' |
/** Grid - Defines the type of the panel as Grid */
'Grid' |
/** WrapPanel - Defines the type of the panel as WrapPanel */
'WrapPanel';
/**
* Defines the orientation
* Horizontal - Sets the orientation as Horizontal
* Vertical - Sets the orientation as Vertical
*/
export declare type Orientation =
/** Horizontal - Sets the orientation as Horizontal */
'Horizontal' |
/** Vertical - Sets the orientation as Vertical */
'Vertical';
/**
* Defines the orientation
* Horizontal - Sets the orientation as Horizontal
* Vertical - Sets the orientation as Vertical
*/
export declare type ContainerTypes =
/** Canvas - Sets the ContainerTypes as Canvas */
'Canvas' |
/** Stack - Sets the ContainerTypes as Stack */
'Stack' |
/** Grid - Sets the ContainerTypes as Grid */
'Grid';
/**
* Defines the reference with respect to which the diagram elements have to be aligned
* Point - Diagram elements will be aligned with respect to a point
* Object - Diagram elements will be aligned with respect to its immediate parent
*/
export declare type RelativeMode =
/** Point - Diagram elements will be aligned with respect to a point */
'Point' |
/** Object - Diagram elements will be aligned with respect to its immediate parent */
'Object';
/**
* Defines how to wrap the text when it exceeds the element bounds
* WrapWithOverflow - Wraps the text so that no word is broken
* Wrap - Wraps the text and breaks the word, if necessary
* NoWrap - Text will no be wrapped
*/
export declare type TextWrap =
/** WrapWithOverflow - Wraps the text so that no word is broken */
'WrapWithOverflow' |
/** Wrap - Wraps the text and breaks the word, if necessary */
'Wrap' |
/** NoWrap - Text will no be wrapped */
'NoWrap';
/**
* Defines how to handle the text when it exceeds the element bounds
* Wrap - Wraps the text to next line, when it exceeds its bounds
* Ellipsis - It truncates the overflown text and represents the clipping with an ellipsis
* Clip - It clips the overflow text
*/
export declare type TextOverflow =
/** Wrap - Wraps the text to next line, when it exceeds its bounds */
'Wrap' |
/** Ellipsis - It truncates the overflown text and represents the clipping with an ellipsis */
'Ellipsis' |
/** Clip - It clips the overflow text */
'Clip';
/**
* Defines how to show tooltip
* Auto - Shows the tooltip on drag, scale, and rotate the object
* Custom - Shows the tooltip for the diagram element
*/
export declare type TooltipMode =
/** Auto - It shows the tooltip On drag,scale,rotate the object */
'Auto' |
/** Custom - It shows tooltip based on object */
'Custom';
/**
* Defines the mode of the alignment based on which the elements should be aligned
* Object - Aligns the objects based on the first object in the selected list
* Selector - Aligns the objects based on the the selector bounds
*/
export declare type AlignmentMode =
/** Object - Aligns the objects based on the first object in the selected list */
'Object' |
/** Selector - Aligns the objects based on the the selector bounds */
'Selector';
/**
* Defines the alignment options
* Left - Aligns the objects at the left of the selector bounds
* Right - Aligns the objects at the right of the selector bounds
* Center - Aligns the objects at the horizontal center of the selector bounds
* Top - Aligns the objects at the top of the selector bounds
* Bottom - Aligns the objects at the bottom of the selector bounds
* Middle - Aligns the objects at the vertical center of the selector bounds
*/
export declare type AlignmentOptions =
/** Left - Aligns the objects at the left of the selector bounds */
'Left' |
/** Right - Aligns the objects at the right of the selector bounds */
'Right' |
/** Center - Aligns the objects at the horizontal center of the selector bounds */
'Center' |
/** Top - Aligns the objects at the top of the selector bounds */
'Top' |
/** Bottom - Aligns the objects at the bottom of the selector bounds */
'Bottom' |
/** Middle - Aligns the objects at the vertical center of the selector bounds */
'Middle';
/**
* Defines the distribution options
* RightToLeft - Distributes the objects based on the distance between the right and left sides of the adjacent objects
* Left - Distributes the objects based on the distance between the left sides of the adjacent objects
* Right - Distributes the objects based on the distance between the right sides of the adjacent objects
* Center - Distributes the objects based on the distance between the center of the adjacent objects
* BottomToTop - Distributes the objects based on the distance between the bottom and top sides of the adjacent objects
* Top - Distributes the objects based on the distance between the top sides of the adjacent objects
* Bottom - Distributes the objects based on the distance between the bottom sides of the adjacent objects
* Middle - Distributes the objects based on the distance between the vertical center of the adjacent objects
*/
export declare type DistributeOptions =
/** RightToLeft - Distributes the objects based on the distance between the right and left sides of the adjacent objects */
'RightToLeft' |
/** Left - Distributes the objects based on the distance between the left sides of the adjacent objects */
'Left' |
/** Right - Distributes the objects based on the distance between the right sides of the adjacent objects */
'Right' |
/** Center - Distributes the objects based on the distance between the center of the adjacent objects */
'Center' |
/** BottomToTop - Distributes the objects based on the distance between the bottom and top sides of the adjacent objects */
'BottomToTop' |
/** Top - Distributes the objects based on the distance between the top sides of the adjacent objects */
'Top' |
/** Bottom - Distributes the objects based on the distance between the bottom sides of the adjacent objects */
'Bottom' |
/** Middle - Distributes the objects based on the distance between the vertical center of the adjacent objects */
'Middle';
/**
* Defines the sizing options
* Width - Scales the width of the selected objects
* Height - Scales the height of the selected objects
* Size - Scales the selected objects both vertically and horizontally
*/
export declare type SizingOptions =
/** Width - Scales the width of the selected objects */
'Width' |
/** Height - Scales the height of the selected objects */
'Height' |
/** Size - Scales the selected objects both vertically and horizontally */
'Size';
/**
* Defines how to handle the empty space and empty lines of a text
* PreserveAll - Preserves all empty spaces and empty lines
* CollapseSpace - Collapses the consequent spaces into one
* CollapseAll - Collapses all consequent empty spaces and empty lines
*/
export declare type WhiteSpace =
/** PreserveAll - Preserves all empty spaces and empty lines */
'PreserveAll' |
/** CollapseSpace - Collapses the consequent spaces into one */
'CollapseSpace' |
/** CollapseAll - Collapses all consequent empty spaces and empty lines */
'CollapseAll';
/**
* Defines how to handle the rubber band selection
* CompleteIntersect - Selects the objects that are contained within the selected region
* PartialIntersect - Selects the objects that are partially intersected with the selected region
*/
export declare type RubberBandSelectionMode =
/** CompleteIntersect - Selects the objects that are contained within the selected region */
'CompleteIntersect' |
/** PartialIntersect - Selects the objects that are partially intersected with the selected region */
'PartialIntersect';
/**
* Defines the rendering mode of the diagram
* SVG - Renders the diagram objects as SVG elements
* Canvas - Renders the diagram in a canvas
*/
export declare type RenderingMode =
/** SVG - Renders the diagram objects as SVG elements */
'SVG' |
/** Canvas - Renders the diagram in a canvas */
'Canvas';
/**
* Defines the connection point of the connectors in the layout
* SamePoint - Connectors will connect with same point in the layout
* DifferentPoint - Connectors will connect with different points in the layout
*/
export declare enum ConnectionPointOrigin {
/** SamePoint - Connectors will connect with same point in the layout */
SamePoint = "SamePoint",
/** DifferentPoint - Connectors will connect with different points in the layout */
DifferentPoint = "DifferentPoint"
}
/**
* Defines the child nodes need to arranged in linear manner in layout
* Linear - Child nodes will be arranged in linear manner
* Nonlinear - Child nodes will be arranged in not linear manner
*/
export declare enum ChildArrangement {
/** Linear - Child nodes will be arranged in linear manner */
Linear = "Linear",
/** Nonlinear - Child nodes will be arranged in not linear manner */
Nonlinear = "Nonlinear"
}
/**
* Defines the gird rendering pattern
* Lines - Render the line for the grid
* Dots - Render the dot for the grid
*/
export declare type GridType =
/** Lines - Render the diagram Grid in Line format */
'Lines' |
/** Lines - Render the diagram Grid in Dot format */
'Dots';
/**
* Defines how to decorate the text
* Overline - Decorates the text with a line above the text
* Underline - Decorates the text with an underline
* LineThrough - Decorates the text by striking it with a line
* None - Text will not have any specific decoration
*/
export declare type TextDecoration =
/** Overline - Decorates the text with a line above the text */
'Overline' |
/** Underline - Decorates the text with an underline */
'Underline' |
/** LineThrough - Decorates the text by striking it with a line */
'LineThrough' |
/** None - Text will not have any specific decoration */
'None';
/**
* Defines how to open the annotation hyperlink in the new tab, current tab or new window
*/
export declare type LinkTarget =
/**Opens hyperlink in the same tab */
'CurrentTab' |
/**Opens hyperlink in the new tab */
'NewTab' |
/**Opens hyperlink in the new window*/
'NewWindow';
/**
* Defines how the text has to be aligned
* Left - Aligns the text at the left of the text bounds
* Right - Aligns the text at the right of the text bounds
* Center - Aligns the text at the center of the text bounds
* Justify - Aligns the text in a justified manner
*/
export declare type TextAlign =
/** Left - Aligns the text at the left of the text bounds */
'Left' |
/** Right - Aligns the text at the right of the text bounds */
'Right' |
/** Center - Aligns the text at the center of the text bounds */
'Center' |
/** Justify - Aligns the text in a justified manner */
'Justify';
/**
* Defines the constraints to enable/disable certain features of connector.
* * None - Interaction of the connectors cannot be done.
* * Select - Selects the connector.
* * Delete - Delete the connector.
* * Drag - Drag the connector.
* * DragSourceEnd - Drag the source end of the connector.
* * DragTargetEnd - Drag the target end of the connector.
* * DragSegmentThump - Drag the segment thumb of the connector.
* * AllowDrop - Allow to drop a node.
* * Bridging - Creates bridge on intersection of two connectors.
* * BridgeObstacle -
* * InheritBridging - Creates bridge on intersection of two connectors.
* * PointerEvents - Sets the pointer events.
* * Tooltip - Displays a tooltip for the connectors.
* * InheritToolTip - Displays a tooltip for the connectors.
* * Interaction - Features of the connector used for interaction.
* * ReadOnly - Enables ReadOnly
* * InheritSegmentThumbShape - Enables or disables to inherit the value of segmentThumbShape
* * InheritSegmentThumbSize - Enables or disables to inherit the value of segmentThumbSize
* * Default - Default features of the connector.
*
* @aspNumberEnum
* @IgnoreSingular
*/
export declare enum ConnectorConstraints {
/** Disable all connector Constraints. */
None = 1,
/** Enables connector to be selected. */
Select = 2,
/** Enables connector to be Deleted. */
Delete = 4,
/** Enables connector to be Dragged. */
Drag = 8,
/** Enables connectors source end to be selected. */
DragSourceEnd = 16,
/** Enables connectors target end to be selected. */
DragTargetEnd = 32,
/** Enables control point and end point of every segment in a connector for editing. */
DragSegmentThumb = 64,
/** Enables AllowDrop constraints to the connector. */
AllowDrop = 128,
/** Enables bridging to the connector. */
Bridging = 256,
/** Enables or Disables Bridge Obstacles with overlapping of connectors. */
BridgeObstacle = 512,
/** Enables bridging to the connector. */
InheritBridging = 1024,
/** Used to set the pointer events. */
PointerEvents = 2048,
/** Enables or disables tool tip for the connectors */
Tooltip = 4096,
/** Enables or disables tool tip for the connectors */
InheritTooltip = 8192,
/** Enables Interaction. */
Interaction = 4218,
/** Enables ReadOnly */
ReadOnly = 16384,
/** Enables or disables routing to the connector. */
LineRouting = 32768,
/** Enables or disables routing to the connector. */
InheritLineRouting = 65536,
/** Enables or disables near node padding to the connector. */
ConnectToNearByNode = 131072,
/** Enables or disables near port padding to the connector. */
ConnectToNearByPort = 262144,
/** Enables or disables Enables or disables near port and node padding to the connector. */
ConnectToNearByElement = 393216,
/**Enables or disables to inherit the value of segmentThumbShape */
InheritSegmentThumbShape = 524288,
/**Enables or disables to inherit the value of segmentThumbSize */
InheritSegmentThumbSize = 1048576,
/** Enables all constraints. */
Default = 2043454
}
/**
* Enables/Disables the annotation constraints
* ReadOnly - Enables/Disables the ReadOnly Constraints
* InheritReadOnly - Enables/Disables the InheritReadOnly Constraints
* Select -Enables/Disable select support for the annotation
* Drag - Enables/Disable drag support for the annotation
* Resize - Enables/Disable resize support for the annotation
* Rotate - Enables/Disable rotate support for the annotation
* Interaction - Enables annotation to inherit the interaction option
* None - Disable all annotation constraints
*
* @aspNumberEnum
* @IgnoreSingular
*/
export declare enum AnnotationConstraints {
/** Enables/Disables the ReadOnly Constraints */
ReadOnly = 2,
/** Enables/Disables the InheritReadOnly Constraints */
InheritReadOnly = 4,
/** Enables/Disable select support for the annotation */
Select = 8,
/** Enables/Disable drag support for the annotation */
Drag = 16,
/** Enables/Disable resize support for the annotation */
Resize = 32,
/** Enables/Disable rotate support for the annotation */
Rotate = 64,
/** Enables or disables tool tip for the annotation */
Tooltip = 128,
/** Enables annotation to inherit the interaction option */
Interaction = 120,
/** Disable all annotation Constraints */
None = 0
}
/**
* Enables/Disables certain features of node
* None - Disable all node Constraints
* Select - Enables node to be selected
* Drag - Enables node to be Dragged
* Rotate - Enables node to be Rotate
* Shadow - Enables node to display shadow
* PointerEvents - Enables node to provide pointer option
* Delete - Enables node to delete
* InConnect - Enables node to provide in connect option
* OutConnect - Enables node to provide out connect option
* Individual - Enables node to provide individual resize option
* Expandable - Enables node to provide Expandable option
* AllowDrop - Enables node to provide allow to drop option
* Inherit - Enables node to inherit the interaction option
* ResizeNorthEast - Enable ResizeNorthEast of the node
* ResizeEast - Enable ResizeEast of the node
* ResizeSouthEast - Enable ResizeSouthEast of the node
* ResizeSouth - Enable ResizeSouthWest of the node
* ResizeSouthWest - Enable ResizeSouthWest of the node
* ResizeSouth - Enable ResizeSouth of the node
* ResizeSouthWest - Enable ResizeSouthWest of the node
* ResizeWest - Enable ResizeWest of the node
* ResizeNorth - Enable ResizeNorth of the node
* Resize - Enables the Aspect ratio fo the node
* AspectRatio - Enables the Aspect ratio fo the node
* Tooltip - Enables or disables tool tip for the Nodes
* InheritTooltip - Enables or disables tool tip for the Nodes
* ReadOnly - Enables the ReadOnly support for Annotation
* Default - Enables all constraints
*
* @aspNumberEnum
* @IgnoreSingular
*/
export declare enum NodeConstraints {
/** Disable all node Constraints. */
None = 0,
/** Enables node to be selected. */
Select = 2,
/** Enables node to be Dragged. */
Drag = 4,
/** Enables node to be Rotate. */
Rotate = 8,
/** Enables node to display shadow. */
Shadow = 16,
/** Enables node to provide pointer option */
PointerEvents = 32,
/** Enables node to delete */
Delete = 64,
/** Enables node to provide in connect option */
InConnect = 128,
/** Enables node to provide out connect option */
OutConnect = 256,
/** Enables node to provide individual resize option */
Individual = 512,
/** Enables node to provide Expandable option */
Expandable = 1024,
/** Enables node to provide allow to drop option */
AllowDrop = 2048,
/** Enables node to inherit the interaction option */
Inherit = 78,
/** Enable ResizeNorthEast of the node */
ResizeNorthEast = 4096,
/** Enable ResizeEast of the node */
ResizeEast = 8192,
/** Enable ResizeSouthEast of the node */
ResizeSouthEast = 16384,
/** Enable ResizeSouth of the node */
ResizeSouth = 32768,
/** Enable ResizeSouthWest of the node */
ResizeSouthWest = 65536,
/** Enable ResizeWest of the node */
ResizeWest = 131072,
/** Enable ResizeNorthWest of the node */
ResizeNorthWest = 262144,
/** Enable ResizeNorth of the node */
ResizeNorth = 524288,
/** Enable Resize of the node */
Resize = 1044480,
/** Enables the Aspect ratio fo the node */
AspectRatio = 1048576,
/** Enables or disables tool tip for the Nodes */
Tooltip = 2097152,
/** Enables or disables tool tip for the Nodes */
InheritTooltip = 4194304,
/** Enables the ReadOnly support for Annotation */
ReadOnly = 8388608,
/** hide all resize support for node */
HideThumbs = 16777216,
/** Enables or disables child in parent for the swimLane node */
AllowMovingOutsideLane = 33554432,
/** Enables all constraints */
Default = 5240814
}
/** Enables/Disables The element actions
* None - Diables all element actions are none
* ElementIsPort - Enable element action is port
* ElementIsGroup - Enable element action as Group
*
* @private
*/
export declare enum ElementAction {
/** Disables all element actions are none */
None = 0,
/** Enable the element action is Port */
ElementIsPort = 2,
/** Enable the element action as Group */
ElementIsGroup = 4,
/** Enable the element action if swimlaneHeader is rendered */
HorizontalLaneHeader = 8
}
/** Enables/Disables the handles of the selector
* Rotate - Enable Rotate Thumb
* ConnectorSource - Enable Connector source point
* ConnectorTarget - Enable Connector target point
* ResizeNorthEast - Enable ResizeNorthEast Resize
* ResizeEast - Enable ResizeEast Resize
* ResizeSouthEast - Enable ResizeSouthEast Resize
* ResizeSouth - Enable ResizeSouth Resize
* ResizeSouthWest - Enable ResizeSouthWest Resize
* ResizeWest - Enable ResizeWest Resize
* ResizeNorthWest - Enable ResizeNorthWest Resize
* ResizeNorth - Enable ResizeNorth Resize
* Default - Enables all constraints
*
* @private
*/
export declare enum ThumbsConstraints {
/** Enable Rotate Thumb */
Rotate = 2,
/** Enable Connector source point */
ConnectorSource = 4,
/** Enable Connector target point */
ConnectorTarget = 8,
/** Enable ResizeNorthEast Resize */
ResizeNorthEast = 16,
/** Enable ResizeEast Resize */
ResizeEast = 32,
/** Enable ResizeSouthEast Resize */
ResizeSouthEast = 64,
/** Enable ResizeSouth Resize */
ResizeSouth = 128,
/** Enable ResizeSouthWest Resize */
ResizeSouthWest = 256,
/** Enable ResizeWest Resize */
ResizeWest = 512,
/** Enable ResizeNorthWest Resize */
ResizeNorthWest = 1024,
/** Enable ResizeNorth Resize */
ResizeNorth = 2048,
/** Enables all constraints */
Default = 4094
}
/**
* Enables/Disables certain features of diagram
* None - Disable DiagramConstraints constraints
* Bridging - Enables/Disable Bridging support for connector
* UndoRedo - Enables/Disable the Undo/Redo support
* Tooltip - Enables/Disable Tooltip support
* UserInteraction - Enables/Disable UserInteraction support for the diagram
* ApiUpdate - Enables/Disable ApiUpdate support for the diagram
* PageEditable - Enables/Disable PageEditable support for the diagram
* Zoom - Enables/Disable Zoom support for the diagram
* PanX - Enables/Disable PanX support for the diagram
* PanY - Enables/Disable PanY support for the diagram
* Pan - Enables/Disable Pan support the diagram
* ZoomTextEdit - Enables/Disables zooming the text box while editing the text
* Virtualization - Enables/Disable Virtualization support the diagram
* LineRouting - Enables/ Disable the line routing
* AvoidLineOverlapping - Enables/Disables the line overlapping resolution globally in the diagram
* Default - Enables/Disable all constraints
*
* @aspNumberEnum
* @IgnoreSingular
*/
export declare enum DiagramConstraints {
/** Disable DiagramConstraints constraints */
None = 1,
/** Enables/Disable Bridging support for connector */
Bridging = 2,
/** Enables/Disable the Undo/Redo support */
UndoRedo = 4,
/** Enables/Disable Tooltip support */
Tooltip = 8,
/** Enables/Disable UserInteraction support for the diagram */
UserInteraction = 16,
/** Enables/Disable ApiUpdate support for the diagram */
ApiUpdate = 32,
/** Enables/Disable PageEditable support for the diagram */
PageEditable = 48,
/** Enables/Disable Zoom support for the diagram */
Zoom = 64,
/** Enables/Disable PanX support for the diagram */
PanX = 128,
/** Enables/Disable PanY support for the diagram */
PanY = 256,
/** Enables/Disable Pan support the diagram */
Pan = 384,
/** Enables/Disables zooming the text box while editing the text */
ZoomTextEdit = 512,
/** Enables/Disable Virtualization support the diagram */
Virtualization = 1024,
/** Enables/ Disable the line routing */
LineRouting = 2048,
/** Enables/Disables the line overlapping resolution globally in the diagram */
AvoidLineOverlapping = 4096,
/** Restricts the drag and drop of objects beyond the top and left (negative) axes of the diagram.When enabled, users will not be able to move objects outside the positive coordinate space.*/
RestrictNegativeAxisDragDrop = 8192,
/** Indicates that ports are created interactively. */
AutomaticPortCreation = 16384,
/** Enables/Disable all constraints */
Default = 500
}
/**
* Activates the diagram tools
* None - Enables/Disable single select support for the diagram
* SingleSelect - Enables/Disable single select support for the diagram
* MultipleSelect - Enables/Disable MultipleSelect select support for the diagram
* ZoomPan - Enables/Disable ZoomPan support for the diagram
* DrawOnce - Enables/Disable continuousDraw support for the diagram
* ContinuousDraw - Enables/Disable continuousDraw support for the diagram
* Default - Enables/Disable all constraints
*
* @aspNumberEnum
* @IgnoreSingular
*/
export declare enum DiagramTools {
/** Disable all constraints */
None = 0,
/** Enables/Disable single select support for the diagram */
SingleSelect = 1,
/** Enables/Disable MultipleSelect select support for the diagram */
MultipleSelect = 2,
/** Enables/Disable ZoomPan support for the diagram */
ZoomPan = 4,
/** Enables/Disable DrawOnce support for the diagram */
DrawOnce = 8,
/** Enables/Disable continuousDraw support for the diagram */
ContinuousDraw = 16,
/** Enables/Disable all constraints */
Default = 3
}
/**
* Defines the bridge direction
* Top - Defines the direction of the bridge as Top
* Bottom - Defines the direction of the bridge as Bottom
* Left - Sets the bridge direction as left
* Right - Sets the bridge direction as right
*/
export declare type BridgeDirection =
/** Top - Defines the direction of the bridge as Top */
'Top' |
/** Bottom - Defines the direction of the bridge as Bottom */
'Bottom' |
/** Left - Sets the bridge direction as left */
'Left' |
/** Right - Sets the bridge direction as right */
'Right';
/**
* Defines the type of the gradient
* Linear - Sets the type of the gradient as Linear
* Radial - Sets the type of the gradient as Radial
*/
export declare type GradientType =
/** None - Sets the type of the gradient as None */
'None' |
/** Linear - Sets the type of the gradient as Linear */
'Linear' |
/** Radial - Sets the type of the gradient as Radial */
'Radial';
/**
* Defines the shape of a node
* Path - Sets the type of the node as Path
* Text - Sets the type of the node as Text
* Image - Sets the type of the node as Image
* Basic - Sets the type of the node as Basic
* Flow - Sets the type of the node as Flow
* Bpmn - Sets the type of the node as Bpmn
* Native - Sets the type of the node as Native
* HTML - Sets the type of the node as HTML
*/
export declare type Shapes =
/** Basic - Sets the type of the node as Basic */
'Basic' |
/** Path - Sets the type of the node as Path */
'Path' |
/** Text - Sets the type of the node as Text */
'Text' |
/** Image - Sets the type of the node as Image */
'Image' |
/** Flow - Sets the type of the node as Flow */
'Flow' |
/** Bpmn - Sets the type of the node as Bpmn */
'Bpmn' |
/** Native - Sets the type of the node as Native */
'Native' |
/** HTML - Sets the type of the node as HTML */
'HTML' |
/** UMLActivity - Sets the type of the node as UMLActivity */
'UmlActivity' |
/** UMLClassifier - Sets the type of the node as UMLClassifier */
'UmlClassifier' |
/** SwimLane - Sets the type of the node as SwimLane */
'SwimLane' |
/** Container - Sets the type of the node as Container */
'Container';
/**
* None - Scale value will be set as None for the image
* Meet - Scale value Meet will be set for the image
* Slice - Scale value Slice will be set for the image
*/
export declare type Scale =
/** None - Scale value will be set as None for the image */
'None' |
/** Meet - Scale value Meet will be set for the image */
'Meet' |
/** Slice - Scale value Slice will be set for the image */
'Slice';
/**
* None - Alignment value will be set as none
* XMinYMin - smallest X value of the view port and smallest Y value of the view port
* XMidYMin - midpoint X value of the view port and smallest Y value of the view port
* XMaxYMin - maximum X value of the view port and smallest Y value of the view port
* XMinYMid - smallest X value of the view port and midpoint Y value of the view port
* XMidYMid - midpoint X value of the view port and midpoint Y value of the view port
* XMaxYMid - maximum X value of the view port and midpoint Y value of the view port
* XMinYMax - smallest X value of the view port and maximum Y value of the view port
* XMidYMax - midpoint X value of the view port and maximum Y value of the view port
* XMaxYMax - maximum X value of the view port and maximum Y value of the view port
*/
export declare type ImageAlignment =
/** None - Alignment value will be set as none */
'None' |
/** XMinYMin - smallest X value of the view port and smallest Y value of the view port */
'XMinYMin' |
/** XMidYMin - midpoint X value of the view port and smallest Y value of the view port */
'XMidYMin' |
/** XMaxYMin - maximum X value of the view port and smallest Y value of the view port */
'XMaxYMin' |
/** XMinYMid - smallest X value of the view port and midpoint Y value of the view port */
'XMinYMid' |
/** XMidYMid - midpoint X value of the view port and midpoint Y value of the view port */
'XMidYMid' |
/** XMaxYMid - maximum X value of the view port and midpoint Y value of the view port */
'XMaxYMid' |
/** XMinYMax - smallest X value of the view port and maximum Y value of the view port */
'XMinYMax' |
/** XMidYMax - midpoint X value of the view port and maximum Y value of the view port */
'XMidYMax' |
/** XMaxYMax - maximum X value of the view port and maximum Y value of the view port */
'XMaxYMax