Canvacord

ImageGenerationTemplate 

Creates a new ImageGenerationTemplate instance.

new ImageGenerationTemplate([width], [height])
ParameterTypeDescriptionOptional
width
number

The width of the template

height
number

The height of the template

Properties

gif

The gif options.

Type:EncoderOptions

readonly height

The height of the template

Type:number

steps

The steps to apply to the canvas.

Type:Array<ImageGenerationStep>

readonly width

The width of the template

Type:number

Methods

addStep(step); 

Adds a step to the template.

ParameterTypeDescriptionOptional
step
ImageGenerationStep

The step to add

Returns:ImageGenerationTemplate

addSteps(steps); 

Adds steps to the template.

ParameterTypeDescriptionOptional
steps
Array<ImageGenerationStep>

The steps to add

Returns:ImageGenerationTemplate

clearSteps(); 

Clears the steps.

Returns:ImageGenerationTemplate

getHeight(); 

Returns the height of the template.

Returns:undefined|number

getWidth(); 

Returns the width of the template.

Returns:undefined|number

isGif(); 

Returns whether the template is a gif.

Returns:boolean

isInferrable(); 

Returns whether the size is inferrable.

Returns:boolean

setGifOptions([options]); 

Sets the gif options.

ParameterTypeDescriptionOptional
options
EncoderOptions

The gif options

Returns:ImageGenerationTemplate

setSteps(steps); 

Sets the steps. This will overwrite any existing steps.

ParameterTypeDescriptionOptional
steps
Array<ImageGenerationStep>

The steps to set

Returns:ImageGenerationTemplate

toJSON(); 

Returns the JSON representation of the template.

Returns:IImageGenerationTemplate

static from(template); 

Creates a new ImageGenerationTemplate instance from a template.

ParameterTypeDescriptionOptional
template
IImageGenerationTemplate

The template to use

Returns:ImageGenerationTemplate

The created template