Skip to main content

  • Creates a job to generate a sequence of raster images that visualize data over a specified time.

    ​
    Parameters

    • attribute: string

      The animated attribute to map to the video’s frames. Must be present in the LAYERS specified for the visualization. This is often a time-related field but may be any numeric type.

    • begin: string

      The start point for the video. Accepts an expression evaluable over the attribute.

    • duration_seconds: number

      Seconds of video to produce.

    • end: string

      The end point for the video. Accepts an expression evaluable over the attribute.

    • frames_per_second: number

      The presentation frame rate of the encoded video in frames per second.

    • style: string

      The name of the visualize mode; should correspond to the schema used for the style_parameters field.

    • path: string

      Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.

    • style_parameters: string

      A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.

    • Optionaloptions: Record<string, string>

      Optional parameters.

    • Optionalcallback: GPUdbCallback

      Optional callback function

    ​
    Returns Promise<CreateVideoResponse>

    Promise<Types.CreateVideoResponse> - Promise resolving to the response