Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

item-02 Parse *data type* of parameters

The column data type of the parameters table is not yet parsed. E.g. from Sequence.AddEffect method (PowerPoint).

NameRequired/OptionalData typeDescription
ShapeRequiredShapeThe shape to which the animation effect is added.
effectIdRequiredMsoAnimEffectThe animation effect to be applied.
LevelOptionalMsoAnimateByLevelFor charts, diagrams, or text, the level to which the animation effect will be applied. The default value is msoAnimationLevelNone.
triggerOptionalMsoAnimTriggerTypeThe action that triggers the animation effect. The default value is msoAnimTriggerOnPageClick.
IndexOptionalLongThe position at which the effect will be placed in the collection of animation effects. The default value is -1 (added to the end).

The parsed information can be used to improve the type hints in the generated code. E.g. the method signature of AddEffect can be improved from

   def AddEffect(self, Shape=None, effectId=None, Level=None, trigger=None, Index=None):

to

   def AddEffect(self, Shape: Shape = None, effectId: int = None, Level: int = None, trigger: int = None, Index: int = None)

Enums are defined as int.

Attention Some functions accept different type of arguments. E.g. Worksheet.Range can take a str and an Excel.Range as first argument.