@syncfusion/ej2-pdfviewer
Version:
Essential JS 2 PDF viewer Component
604 lines (603 loc) • 21.9 kB
TypeScript
/**
* enum module defines the public enumerations
*/
/**
* @hidden
* 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';
/**
* @hidden
* 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 =
/** Underline LineThrough - Decorates the text with an underline and strikeout */
'Underline LineThrough' |
/** 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';
/**
* @hidden
* 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';
/**
* @hidden
* 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';
/**
* @hidden
* 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';
/**
* @hidden
* 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';
/**
* @hidden
* 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';
/**
* @hidden
* 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';
/**
* @hidden
* Defines the unit mode
* Absolute - Sets the unit mode type as Absolute
* Fraction - Sets the unit mode type as Fraction
*/
export declare type UnitMode =
/** Absolute - Sets the unit mode type as Absolute */
'Absolute' |
/** Fraction - Sets the unit mode type as Fraction */
'Fraction';
/**
* @hidden
* Defines the container/canvas transform
* Self - Sets the transform type as Self
* Parent - Sets the transform type as Parent
*/
export declare enum RotateTransform {
/** Self - Sets the transform type as Self */
Self = 1,
/** Parent - Sets the transform type as Parent */
Parent = 2
}
/**
* @hidden
* 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
}
/**
* @hidden
* 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';
/**
* @hidden
* 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';
/**
* @hidden
* Defines the decorator shape of the connector
* None - Sets the decorator shape as None
* Arrow - Sets the decorator shape as Arrow
* Diamond - Sets the decorator shape as Diamond
* Butt - Sets the decorator shape as Butt
* Path - Sets the decorator shape as Path
* OpenArrow - Sets the decorator shape as OpenArrow
* Circle - Sets the decorator shape as Circle
* Square - Sets the decorator shape as Square
* Fletch - Sets the decorator shape as Fletch
* OpenFetch - Sets the decorator shape as OpenFetch
* IndentedArrow - Sets the decorator shape as Indented Arrow
* OutdentedArrow - Sets the decorator shape as Outdented Arrow
* DoubleArrow - Sets the decorator shape as DoubleArrow
*/
export declare type DecoratorShapes =
/** None - Sets the decorator shape as None */
'None' |
/** Arrow - Sets the decorator shape as Arrow */
'Arrow' |
/** Diamond - Sets the decorator shape as Diamond */
'Diamond' |
/** Butt - Sets the decorator shape as Butt */
'Butt' |
/** OpenArrow - Sets the decorator shape as OpenArrow */
'OpenArrow' |
/** Circle - Sets the decorator shape as Circle */
'Circle' |
/** Square - Sets the decorator shape as Square */
'Square' |
/** Fletch - Sets the decorator shape as Fletch */
'Fletch' |
/** OpenFetch - Sets the decorator shape as OpenFetch */
'OpenFetch' |
/** IndentedArrow - Sets the decorator shape as Indented Arrow */
'IndentedArrow' |
/** OutdentedArrow - Sets the decorator shape as Outdented Arrow */
'OutdentedArrow' |
/** DoubleArrow - Sets the decorator shape as DoubleArrow */
'DoubleArrow' |
/** Custom - Sets the decorator shape as Custom */
'Custom';
/**
* @hidden
* Enables/Disables shape of the uml classifier shapes
* * Package - Indicates the scope is public.
* * Class - Indicates the scope is protected.
* * Interface - Indicates the scope is private.
* * Enumeration - Indicates the scope is package.
* * CollapsedPackage - Indicates the scope is public.
* * Inheritance - Indicates the scope is protected.
* * Association - Indicates the scope is private.
* * Aggregation - Indicates the scope is package.
* * Composition - Indicates the scope is public.
* * Realization - Indicates the scope is protected.
* * DirectedAssociation - Indicates the scope is private.
* * Dependency - Indicates the scope is package.
*/
export declare type ClassifierShape = 'Class' | 'Interface' | 'Enumeration' | 'Inheritance' | 'Association' | 'Aggregation' | 'Composition' | 'Realization' | 'Dependency';
/**
* @hidden
* Defines the direction the uml connectors
* * Default - Indicates the direction is Default.
* * Directional - Indicates the direction is single Directional.
* * BiDirectional - Indicates the direction is BiDirectional.
*/
export declare type AssociationFlow = 'Default' | 'Directional' | 'BiDirectional';
/**
* @hidden
* Define the Multiplicity of uml connector shapes
* * OneToOne - Indicates the connector multiplicity is OneToOne.
* * OneToMany - Indicates the connector multiplicity is OneToMany.
* * ManyToOne - Indicates the connector multiplicity is ManyToOne.
* * ManyToOne - Indicates the connector multiplicity is ManyToOne.
*/
export declare type Multiplicity = 'OneToOne' | 'OneToMany' | 'ManyToOne' | 'ManyToOne';
/**
* @hidden
* Defines the segment type of the connector
* Straight - Sets the segment type as Straight
*/
export declare type Segments =
/** Straight - Sets the segment type as Straight */
'Straight';
/**
* @hidden
* 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
* * 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 all constraints. */
Default = 11838
}
/**
* @hidden
* Defines the objects direction
* Left - Sets the direction type as Left
* Right - Sets the direction type as Right
* Top - Sets the direction type as Top
* Bottom - Sets the direction type as Bottom
*/
export declare type Direction =
/** Left - Sets the direction type as Left */
'Left' |
/** Right - Sets the direction type as Right */
'Right' |
/** Top - Sets the direction type as Top */
'Top' |
/** Bottom - Sets the direction type as Bottom */
'Bottom';
/**
* @hidden
* 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';
/**
* @hidden
* Detect the status of Crud operation performed in the diagram
*/
export declare type Status = 'None' | 'New' | 'Update';
/**
* @hidden
* 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
}
/**
* @hidden
* 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
}
/**
* @hidden
* 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';
/** @private */
export declare enum NoOfSegments {
Zero = 0,
One = 1,
Two = 2,
Three = 3,
Four = 4,
Five = 5
}
/**
* @hidden
* collection of alignment values for the image
* 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';
/**
* @hidden
* Defines the diagrams stretch
* None - Sets the stretch type for diagram as None
* Stretch - Sets the stretch type for diagram as Stretch
* Meet - Sets the stretch type for diagram as Meet
* Slice - Sets the stretch type for diagram as Slice
*/
export declare type Stretch =
/** None - Sets the stretch type for diagram as None */
'None' |
/** Stretch - Sets the stretch type for diagram as Stretch */
'Stretch' |
/** Meet - Sets the stretch type for diagram as Meet */
'Meet' |
/** Slice - Sets the stretch type for diagram as Slice */
'Slice';
/**
* @hidden
* collections of scale values for the image
* 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';