Canvas State Variable Reference

Related documents

• State Variables Overview
• StateVar Reference
• Output SV Type Reference
• Input SV Type Reference

Table of contents

• Introduction
• Constructor
• Instance methods
  • Inherited methods
• Instance properties
  • Inherited properties
• DOM element properties

Introduction

Canvas state variables represent HTML canvas outputs

The value of a Canvas state variable is a function with the following signature:

canvasFn (node)

where node is a DOM <canvas> element. The state variable is considered changed every time it is assigned. Once changed, every Component rendering the state variable will call the function with the Component's <canvas> node. The function can then extract a drawing context and query any node size properties.

Constructor

• Type string: 'canvas', class: CanvasSvCmp

Syntax

ctl.createPage({
	...,
	stateVarInfo:[
		{type:'canvas', ...},
	],
})

Parameters

• info
  An object containing the state variable properties. The info object can contain the following properties, but subclasses of StateVar may have additional properties:
  • StateVar info properties.
  • Model SV type info properties.
  • Output SV type info properties.

Instance methods

Inherited methods

• StateVar methods
• ModelValueSv methods
• OutputSv methods

Note: The component() method returns a CanvasSvCmp.

Instance properties

Inherited properties

• StateVar properties
• ModelValueSv properties
• OutputSv properties

DOM element properties

• Standard DOM element properties
• The DOM will contain a <canvas> element.
• The DOM element will have a className that contains 'svIo_booleanInput'