BH.oM.PowerPoint.MultiPolylineUpdate¶
Allows to change the geometry of a shape element.
Class structure¶
Implemented interfaces and base types¶
The MultiPolylineUpdate is inheriting from the following base type(s) and implements the following interfaces:
- BH.oM.Base.BHoMObject
- BH.oM.Base.IBHoMObject
- BH.oM.Base.IObject
- BH.oM.PowerPoint.ISlideUpdate
- BH.oM.PowerPoint.IExcelModification
- BH.oM.PowerPoint.IPowerPointModification
Properties¶
Defining properties¶
The following properties are defined on the class
Name | Type | Description | Quantity |
---|---|---|---|
SlideNumber | int | Number of the slide where the update needs to happen. | - |
ElementName | string | Name of the shape element that needs to be updated. | - |
Shapes | List<PolylineData> | Shape to be updated. | - |
CentreShapes | bool | If true, the provided shapes are centred in the template box, if false, the shapes are drawn from the top left corner. | - |
KeepShapeAspectRatio | bool | If true, the shape aspect ratio is kept, and the shapes are made to fit the extents of the template shape. If false, the shapes are atempted to fill up the template shape as much as possible which can lead to change in aspect ratio of the provided shapes. | - |
GroupPolylinesWithSameProperties | bool | If true, the provided shapes that share all properties in terms of colours will be added to the same shape object. If false, all PolylineData obejcts will be added to separate shape objects. | - |
Scale | double | Scale factor to be applied to the figure. | - |
Inherited properties¶
The following properties are inherited from the base class of the object
Name | Type | Description | Quantity |
---|---|---|---|
BHoM_Guid | Guid | - | - |
Name | string | - | - |
Fragments | FragmentSet | - | - |
Tags | HashSet<string> | - | - |
CustomData | Dictionary<string, object> | - | - |
Code and Schema¶
C# implementation¶
C#
public class MultiPolylineUpdate : BH.oM.Base.BHoMObject,
BH.oM.Base.IBHoMObject,
BH.oM.Base.IObject,
BH.oM.PowerPoint.ISlideUpdate,
BH.oM.PowerPoint.IExcelModification,
BH.oM.PowerPoint.IPowerPointModification
Assembly: PowerPoint_oM.dll
The C# class definition is available on github:
All history and changes of the class can be found by inspection the history.
JSON Schema implementation¶
The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.
JSON Schema
{
"$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/PowerPoint_oM/MultiPolylineUpdate.json"
}
The JSON Schema is available on github here: