timeslideranimation

This configuration is optional when using the plugin Gis.

  • Documentation

  • YAML Format

  • XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.
<TimeSliderConfig
<notice
<font
family
required
=
string

Font family. Value could be e.g. Arial.

size
optional
=
int

Font size. Value could be e.g. 10.

Default: 12

style
optional
=
string

Font style. Value could be e.g. italic bold. Extra styles are separated by space.

Default: plain

>
required

Details of the font, font style, and font size in which the note is output. Important: Fonts used for the note must be available on the client.

</font>
<text
>
required
string

Text of the note. If the text is too long, it will automatically be wrapped to multiple lines. Explicit line breaks are not supported.

</text>
>
optional

Details of the note. If configured, the note will be displayed at the bottom left corner of each animation and exported with each video file. By default, no note will be displayed.

</notice>
<closingCredits
enabled
optional
=
boolean

true to display closing credits for the exported MP4 video file. false to hide closing credits.

Default: true

<text
>
optional
string

Text displayed in the closing credits of the video. Environment variables and system properties can be used, e.g., the date at the time of animation creation (not at the time of video export).

</text>
>
optional

The closing credits can optionally be displayed at the end of an exported MP4 video file and provide contextual information. The closing credits contain the heading with the name of the workbook, the worksheet and the map view as well as the filter assignment when creating the animation. An optional text can also be added.

</closingCredits>
<animation
<defaultNumberOfFrames
>
required
int

Number of frames for the map animation, preset in the filter settings. Th user can adjust this number in the filter settings.

Default: 100

</defaultNumberOfFrames>
<maximumNumberOfFrames
>
required
int

Maximum number of frames for the map animation that can be set in the filter settings.

Default: 100

</maximumNumberOfFrames>
>
optional

When generating the animation, the filter assignment is changed step by step along the value range and the corresponding single frame is included in the map animation. As the resources and time required to create an animation can be large (also on the data source side), you can limit the maximum number of frames for the application.

</animation>
>
required

Configuration to add information to the map animation and to the exported MP4 video file, and to limit the frames for the animation

</TimeSliderConfig>
This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not.
cadenzaconfig:
  settings:
    timeslideranimation:
      notice:
        font:
          family: "text"
          size: 15
          style: "text"
        text: "text"
      closingCredits:
        enabled: true
        text: "text"
      animation:
        defaultNumberOfFrames: 15
        maximumNumberOfFrames: 15

Filename: timeslideranimation-config.xml

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TimeSliderConfig>
  <notice>
    <font family="text" size="15" style="text"/>
    <text>text</text>
  </notice>
  <closingCredits enabled="true">
    <text>text</text>
  </closingCredits>
  <animation>
    <defaultNumberOfFrames>15</defaultNumberOfFrames>
    <maximumNumberOfFrames>15</maximumNumberOfFrames>
  </animation>
</TimeSliderConfig>