Set an Animation

Introduction

Animation in PowerPoint presentations is a powerful tool for creating interactive and engaging presentations. It enables the addition of motion, transition effects between slides, and other animated elements to make your presentation more dynamic and memorable. The following method allows you to set an animation for a presentation shape or text. The animation can be set to both the main and interactive sequences.

SetAnimation

API Information

API	Type	Description	Resource
/slides/{name}/slides/{slideIndex}/animation	PUT	Sets an animation for a shape or text.	SetAnimation

Request Parameters

Name	Type	Location	Required	Description
name	string	path	true	The name of a presentation file saved in a storage.
slideIndex	integer	path	true	The 1-based index of a slide.
animation	`SlideAnimation`	body	true	The data transfer object with animation parameters.
password	string	header	false	The password to open the presentation.
folder	string	query	false	The folder where the presentation file is located.
storage	string	query	false	The storage where the folder is located.

Example 1

The document MyPresentation1.pptx has three shapes on the first slide. Set the Fade effect to the second shape and trigger it to begin playing after the previous animation. Set the Blink effect to the third shape and trigger it to begin playing when clicked.

cURL Solution

Request

Get an Access Token

curl POST "https://api.aspose.cloud/connect/token" \
     -d "grant_type=client_credentials&client_id=MyClientId&client_secret=MyClientSecret" \
     -H "Content-Type: application/x-www-form-urlencoded"

Set the Animations

curl -X PUT "https://api.aspose.cloud/v3.0/slides/MyPresentation1.pptx/slides/1/animation" \
     -H "authorization: Bearer MyAccessToken" \
     -H "Content-Type: application/json" \
     -d @Animation1.json

Animation1.json content:

{
  "MainSequence": [
    {
      "ShapeIndex": 2,
      "Type": "Fade",
      "TriggerType": "AfterPrevious"
    },
    {
      "ShapeIndex": 3,
      "Type": "Blink",
      "TriggerType": "OnClick"
    }
  ]
}

Response

Response Example

{
  "mainSequence": [
    {
      "type": "Fade",
      "subtype": "None",
      "presetClassType": "Entrance",
      "shapeIndex": 2,
      "duration": 0.5,
      "triggerDelayTime": 0.0
    },
    {
      "type": "Blink",
      "subtype": "None",
      "presetClassType": "Emphasis",
      "shapeIndex": 3,
      "triggerType": "OnClick",
      "duration": 1.0,
      "triggerDelayTime": 0.0
    }
  ],
  "interactiveSequences": [],
  "selfUri": {
    "href": "https://api.aspose.cloud/v3.0/slides/MyPresentation1.pptx/slides/1/animation",
    "relation": "self",
    "slideIndex": 1
  }
}

SDK Solutions

using System;
using System.Collections.Generic;

using Aspose.Slides.Cloud.Sdk;
using Aspose.Slides.Cloud.Sdk.Model;

class Application
{
    static void Main(string[] args)
    {
        SlidesApi slidesApi = new SlidesApi("MyClientId", "MyClientSecret");

        string fileName = "MyPresentation1.pptx";
        int slideIndex = 1;

        SlideAnimation newAnimation = new SlideAnimation
        {
            MainSequence = new List<Effect>
            {
                new Effect
                {
                    ShapeIndex = 2,
                    Type = Effect.TypeEnum.Fade,
                    TriggerType = Effect.TriggerTypeEnum.AfterPrevious
                },
                new Effect
                {
                    ShapeIndex = 3,
                    Type = Effect.TypeEnum.Blink,
                    TriggerType = Effect.TriggerTypeEnum.OnClick
                }
            }
        };

        SlideAnimation slideAnimation = slidesApi.SetAnimation(fileName, slideIndex, newAnimation);

        int effectCount = slideAnimation.MainSequence.Count;
        Console.WriteLine("Effect count: " + effectCount); // 2
    }
}

Java

import com.aspose.slides.ApiException;
import com.aspose.slides.api.SlidesApi;
import com.aspose.slides.model.SlideAnimation;
import com.aspose.slides.model.Effect;

import java.util.List;

public class Application {
    public static void main(String[] args) throws ApiException {
        SlidesApi slidesApi = new SlidesApi("MyClientId", "MyClientSecret");

        String fileName = "MyPresentation1.pptx";
        int slideIndex = 1;

        Effect effect1 = new Effect();
        effect1.setShapeIndex(2);
        effect1.setType(Effect.TypeEnum.FADE);
        effect1.setTriggerType(Effect.TriggerTypeEnum.AFTERPREVIOUS);

        Effect effect2 = new Effect();
        effect2.setShapeIndex(3);
        effect2.setType(Effect.TypeEnum.BLINK);
        effect2.setTriggerType(Effect.TriggerTypeEnum.ONCLICK);

        List<Effect> effects = Arrays.asList(effect1, effect2);

        SlideAnimation newAnimation = new SlideAnimation();
        newAnimation.setMainSequence(effects);

        SlideAnimation slideAnimation = slidesApi.setAnimation(fileName, slideIndex, newAnimation, null, null, null);

        int effectCount = slideAnimation.getMainSequence().size();
        System.out.println("Effect count: " + effectCount); // 2
    }
}

PHP

use Aspose\Slides\Cloud\Sdk\Api\Configuration;
use Aspose\Slides\Cloud\Sdk\Api\SlidesApi;
use Aspose\Slides\Cloud\Sdk\Model\Effect;
use Aspose\Slides\Cloud\Sdk\Model\SlideAnimation;

$configuration = new Configuration();
$configuration->setAppSid("MyClientId");
$configuration->setAppKey("MyClientSecret");

$slidesApi = new SlidesApi(null, $configuration);

$fileName = "MyPresentation1.pptx";
$slideIndex = 1;

$effect1 = new Effect();
$effect1->setShapeIndex(2);
$effect1->setType(Effect::TYPE_FADE);
$effect1->setTriggerType(Effect::TRIGGER_TYPE_AFTER_PREVIOUS);

$effect2 = new Effect();
$effect2->setShapeIndex(3);
$effect2->setType(Effect::TYPE_BLINK);
$effect2->setTriggerType(Effect::TRIGGER_TYPE_ON_CLICK);

$effects = [$effect1, $effect2];

$newAnimation = new SlideAnimation();
$newAnimation->setMainSequence($effects);

$slideAnimation = $slidesApi->setAnimation($fileName, $slideIndex, $newAnimation);

$effectCount = count($slideAnimation->getMainSequence());
echo "Effect count: ", $effectCount; // 2

Ruby

require "aspose_slides_cloud"

include AsposeSlidesCloud

configuration = Configuration.new
configuration.app_sid = "MyClientId"
configuration.app_key = "MyClientSecret"

slides_api = SlidesApi.new(configuration)

file_name = "MyPresentation1.pptx"
slide_index = 1

effect1 = Effect.new
effect1.shape_index = 2
effect1.type = "Fade"
effect1.trigger_type = "AfterPrevious"

effect2 = Effect.new
effect2.shape_index = 3
effect2.type = "Blink"
effect2.trigger_type = "OnClick"

effects = [effect1, effect2]

new_animation = SlideAnimation.new
new_animation.main_sequence = effects

slide_animation = slides_api.set_animation(file_name, slide_index, new_animation)

effect_count = slide_animation.main_sequence.length()
print "Effect count: ", effect_count # 2

Python

from asposeslidescloud.apis.slides_api import SlidesApi
from asposeslidescloud.models.effect import Effect
from asposeslidescloud.models.slide_animation import SlideAnimation

slides_api = SlidesApi(None, "MyClientId", "MyClientSecret")

file_name = "MyPresentation1.pptx"
slide_index = 1

effect1 = Effect()
effect1.shape_index = 2
effect1.type = "Fade"
effect1.trigger_type = "AfterPrevious"

effect2 = Effect()
effect2.shape_index = 3
effect2.type = "Blink"
effect2.trigger_type = "OnClick"

effects = [effect1, effect2]

new_animation = SlideAnimation()
new_animation.main_sequence = effects

slide_animation = slides_api.set_animation(file_name, slide_index, new_animation)

effect_count = len(slide_animation.main_sequence)
print("Effect count:", effect_count)  # 2

Node.js

const cloudSdk = require("asposeslidescloud");

const slidesApi = new cloudSdk.SlidesApi("MyClientId", "MyClientSecret");

fileName = "MyPresentation1.pptx";
slideIndex = 1;

effect1 = new cloudSdk.Effect();
effect1.shapeIndex = 2;
effect1.type = cloudSdk.Effect.TypeEnum.Fade;
effect1.triggerType = cloudSdk.Effect.TriggerTypeEnum.AfterPrevious;

effect2 = new cloudSdk.Effect();
effect2.shapeIndex = 3;
effect2.type = cloudSdk.Effect.TypeEnum.Blink;
effect2.triggerType = cloudSdk.Effect.TriggerTypeEnum.OnClick;

effects = [effect1, effect2];

newAnimation = new cloudSdk.SlideAnimation();
newAnimation.mainSequence = effects;

slidesApi.setAnimation(fileName, slideIndex, newAnimation).then(slideAnimation => {
    effectCount = slideAnimation.body.mainSequence.length;
    console.log("Effect count:", effectCount); // 2
});

C++

#include "asposeslidescloud/api/SlidesApi.h"

using namespace asposeslidescloud::api;

int main()
{
    std::shared_ptr<SlidesApi> slidesApi = std::make_shared<SlidesApi>(L"MyClientId", L"MyClientSecret");

    const wchar_t* fileName = L"MyPresentation1.pptx";
    int slideIndex = 1;

    std::shared_ptr<Effect> effect1 = std::make_shared<Effect>();
    effect1->setShapeIndex(2);
    effect1->setType(L"Fade");
    effect1->setTriggerType(L"AfterPrevious");

    std::shared_ptr<Effect> effect2 = std::make_shared<Effect>();
    effect2->setShapeIndex(3);
    effect2->setType(L"Blink");
    effect2->setTriggerType(L"OnClick");

    std::initializer_list<std::shared_ptr<Effect>> effects = { effect1, effect2 };

    std::shared_ptr<SlideAnimation> newAnimation = std::make_shared<SlideAnimation>();
    newAnimation->setMainSequence(effects);

    std::shared_ptr<SlideAnimation> slideAnimation = slidesApi->setAnimation(fileName, slideIndex, newAnimation).get();

    int effectCount = slideAnimation->getMainSequence().size();
    std::wcout << L"Effect count: " << effectCount; // 2
}

Perl

use AsposeSlidesCloud::Configuration;
use AsposeSlidesCloud::SlidesApi;
use AsposeSlidesCloud::Object::Effect;
use AsposeSlidesCloud::Object::SlideAnimation;

my $config = AsposeSlidesCloud::Configuration->new();
$config->{app_sid} = "MyClientId";
$config->{app_key} = "MyClientSecret";

my $slides_api = AsposeSlidesCloud::SlidesApi->new(config => $config);

my $file_name = "MyPresentation1.pptx";
my $slide_index = 1;

my $effect1 = AsposeSlidesCloud::Object::Effect->new();
$effect1->{shape_index} = 2;
$effect1->{type} = "Fade";
$effect1->{trigger_type} = "AfterPrevious";

my $effect2 = AsposeSlidesCloud::Object::Effect->new();
$effect2->{shape_index} = 3;
$effect2->{type} = "Blink";
$effect2->{trigger_type} = "OnClick";

my $effects = [$effect1, $effect2];

my $new_animation = AsposeSlidesCloud::Object::SlideAnimation->new();
$new_animation->{main_sequence} = $effects;

my %parameters = (name => $file_name, slide_index => $slide_index, animation => $new_animation);
my $slide_animation = $slides_api->set_animation(%parameters);

my $effect_count = @{$slide_animation->{main_sequence}};
print("Effect count: ", $effect_count); # 2

Swift

Example 2

The document MyPresentation2.pptx has four shapes on the first slide. Set the Fly effect from below for the fourth shape by clicking on the second shape.