Documentation

Standard Shapes

Description

The Standard Shapes module allows embedding basic shapes into the presentation, including squares, rectangles, or circles.

Properties

The list starts with the common properties. Learn more about them by visiting the Modules description section. The other available properties are described below.

Property name Description
Shape Defines which one of the predefined shapes should be displayed. The choice is between: Line, Square, Rectangle, Circle, and Ellipse.
Rotation angle The angle (counted in degrees) of the shape rotation. It should be between 0 and 360 degrees.
Stroke width Width of the pencil that draws the shape.
Stroke color Color of the pencil that draws the shape. It is specified in the '#RRGGBB' notation.
Corners rounding With this option selected, the selected shape will have rounded corners (applies to Line, Square, and Rectangle).
Line ending Applies only to the Line. The choice is between: None (default), Circles (oval ending on each side), Arrows (arrows on each side), None - Arrow (arrow on the right side), None - Circle (oval on the right side), and Circle - Arrow.
Stroke opacity Opacity of the pencil that draws the shape. Be aware of the anti-aliasing effect! The opacity value should be between 0 (transparent) and 1 (default).
Fill color Color of the shape's filling, specified in the '#RRGGBB' notation.

Supported commands

Command name Params Description
hide --- Hides the module if it is visible.
show --- Shows the module if it is hidden.

CSS classes

Class name Description
standardshapes-wrapper DIV surrounding the shape element. The shape itself is an SVG tag, which in this case is a direct child of this element.

Possible errors

Error message Description
Rotation angle must be between 0 and 360 degrees!
Rotation angle is not a number!
These error messages suggest that the 'Rotation angle' property was not set correctly.
Stroke width must be a positive number.
Stroke width is not a number!
These error messages suggest that the 'Stroke width' property was not set correctly.
Stroke color must be in RGB format (hexadecimal) and start with #. This error message suggests that the 'Stroke color' (or the 'Fill color') property was set in the wrong notation.
Stroke opacity must be a positive number between 0 and 1.
Stroke opacity is not a number!
These error messages suggest that the 'Stroke opacity' property was not set correctly.

Demo presentation

Demo presentation contains examples of how to use the Standard Shapes module.