Classes

The following classes are available globally.

  • An object representing the value of a textLayer’s text alignment property. This object can take on the following values: natural, left, right, center or justified.

    See more

    Declaration

    class Alignment
  • A geometric angle whose value you access in either radians or degrees.

    See more

    Declaration

    class Angle
  • An object representing the animation of a layer’s property. For example, an animation may represent a change in a layer’s x-position of opacity.

    See more

    Declaration

    class Animation
  • A group of animations that share the same start time, duration and timing function.

    See more

    Declaration

    class AnimationGroup
  • An object which encapsulate all the timing information of an animation.

    See more

    Declaration

    class AnimationTiming
  • An object used to store color data using the rgba color space.

    See more

    Declaration

    class Color
  • A CompositePath is a path composed of one or more subpaths. Composite paths in Flow are stored in normalized coordinates, that is they fit within a unit square.

    See more

    Declaration

    class CompositePath
  • A Configuration represents the “state” of a layer hierarchy at a given point in time by associating values to the properties of the layers.

    See more

    Declaration

    class Configuration
  • An object representing the content mode of a view. It defines how a view’s content fills the available space. This object can take on the following values: center, top, bottom, left, right, topLeft, topRight, bottomLeft, bottomRight, resize, resizeAspect, and resizeAspectFill.

    See more

    Declaration

    class ContentMode
  • An object representing a flow document.

    See more

    Declaration

    class Document
  • A fill image consist of an image and a pattern fill type which determines how the image should be used to fill an area.

    See more

    Declaration

    class FillImage
  • An object representing a text font.

    See more

    Declaration

    class Font
  • A color gradient represented as an array of color stops, each having a parametric location value.

    See more

    Declaration

    class Gradient
  • A gradient stop stores information used by a gradient to determine how to transition between colors.

    See more

    Declaration

    class GradientStop
  • An object representing an image bit map.

    See more

    Declaration

    class Image
  • An object used to group a set of keyvalues which share a common time.

    See more

    Declaration

    class Keyframe
  • A keyvalue indicates the value of a property at a point in time.

    See more

    Declaration

    class Keyvalue
  • An object used to represent a visual element in a timeline. Layers are assembled hierarchically to form a “Layer Hierarchy”.

    See more

    Declaration

    class Layer
  • A LayerSnapshot represents a snapshot of a Layer at a specific point in the animation by specifying values for all of the layer’s visual properties.

    See more

    Declaration

    class LayerSnapshot
  • An object representing a layer’s type. There are 5 type of layers: group, image, path, shape, text and shapeMask. Image layers are used to diplay images. Text layers are used to display text. Shape layers display shapes. Path are used to build Shape layers. Group layers are used to group layers, and in turn assemble layers into a “Layer Hierarchy”. ShapeMask layers are used to maks the contents of other layers.

    See more

    Declaration

    class LayerType
  • Object representing the line cap of a layer’s stroke.

    See more

    Declaration

    class LineCap
  • An object representing the line join of a layer’s stroke.

    See more

    Declaration

    class LineJoin
  • A string object that contains style attributes associated to portions of its text.

    See more

    Declaration

    class NSAttributedString
  • The paragraph or ruler attributes used by an attributed string.

    See more

    Declaration

    class NSParagraphStyle
  • An object representing a layer’s drop shadow.

    See more

    Declaration

    class NSShadow
  • An object representing a curved path in 2-dimensional space. The path is defined by a contiguous sequence of cubic bezier curves.

    See more

    Declaration

    class Path
  • An object which represents the start or end point of a cubic bezier curve.

    See more

    Declaration

    class PathPoint
  • An object representing a style attribute of a Layer.

    See more

    Declaration

    class Property
  • An object containing the list of resizing constraints which must be upheld when resizing a Layer as a result of resizing it’s parent.

    See more

    Declaration

    class ResizingConstraint
  • A scene contains a layer hierarchy which is animated over time.

    See more

    Declaration

    class Scene
  • An object representing a auditory sound.

    See more

    Declaration

    class Sound
  • A sound track contains a sound and timing informating dictating when to play it.

    See more

    Declaration

    class SoundTrack
  • An abstract symbol which is registered/tracked within a SymbolTable.

    See more

    Declaration

    class Symbol
  • A data structure used to register and track a set of abstract symbols in order to avoid naming collisions.

    See more

    Declaration

    class SymbolTable
  • A Timeline contains a scene, along with a set of tracks which express how the scene’s layer hierarchy is animated over time.

    See more

    Declaration

    class Timeline
  • A TimingFunction is a function which specifies how a value progresses as a function of time. In Flood this function is represented by a cubic bezier curve which is implicitly assumed to begin at (0, 0) and end at (1,1).

    See more

    Declaration

    class TimingFunction
  • A Track expresses how the value of a layer’s property is animated over the entire duration of a timeline.

    See more

    Declaration

    class Track
  • An object representing a text truncation scheme.

    See more

    Declaration

    class Truncation