Class: LayerProperties

model/Presentation.LayerProperties(obj)

Layer properties for a frame in a Sozi presentation.

In a given frame, one instance of this class is created for each layer. An instance of LayerProperties provides information about the properties of a frame in a given layer.

Constructor

new LayerProperties(obj)

Initialize a new layer properties object.

If the argument is another instance of LayerProperties, this constructor will create a copy of of that instance. If the argument is a Frame instance, an object with default properties will be created.

Parameters:
Name Type Description
obj LayerProperties | Frame

An instance to copy, or a frame.
Source:
To Do:
  • Find a better name for this class.

Members

frame :module:model/Presentation.Frame

The frame that owns the current object.

Type:
Source:

(readonly) index :number

The index of the current layer.

Type:
  • number
Source:

Does the current frame copy the geometry of the previous frame in the current layer?

Type:
  • boolean
Source:

(readonly, nullable) outlineElement :SVGElement

The SVG element used to outline the current frame in the current layer.

Type:
  • SVGElement
Source:

outlineElementHide :boolean

Will the outline element be hidden when playing the presentation?

Type:
  • boolean
Source:

outlineElementId :string

The SVG ID of the outline element for the current frame in the current layer.

Type:
  • string
Source:

(readonly, nullable) referenceElement :SVGElement

The reference SVG element of the current frame in the current layer.

Type:
  • SVGElement
Source:

referenceElementId :string

The SVG ID of the reference element for the current frame in the current layer.

Type:
  • string
Source:

(readonly, nullable) transitionPath :SVGElement

The SVG path to follow in transitions to the current frame in the current layer.

Type:
  • SVGElement
Source:

transitionPathHide :boolean

Will the transition path be hidden when playing the presentation?

Type:
  • boolean
Source:

transitionPathId :string

The SVG ID of a path to follow during the transition to the current frame in the current layer.

Type:
  • string
Source:

transitionRelativeZoom :number

The relative zoom factor for the transition to the current frame in the current layer.

Type:
  • number
Source:

transitionTimingFunction :string

The name of the timing function for the transition to the current frame in the current layer.

Type:
  • string
Default Value:
  • linear
Source:

Methods

copy(other)

Copy another layer properties into the current instance.

Parameters:
Name Type Description
other module:model/Presentation.LayerProperties

The object to copy.
Source:

fromStorable(storable)

Copy the properties of the given object into this instance.

Parameters:
Name Type Description
storable object

A plain object with the properties to copy.
Source:

toMinimalStorable() → {object}

Convert this instance to a plain object that can be stored as JSON.

The result contains only the properties needed by the Sozi player to show and animate the presentation.

Source:
Returns:
  • A plain object with the properties needed by the player.
Type
object

toStorable() → {object}

Convert this instance to a plain object that can be stored as JSON.

The result contains all the properties needed by the editor to restore the state of this instance.

Source:
Returns:
  • A plain object with the properties needed by the editor.
Type
object