Global

Type Definitions


InPlaceEditor

Represents an in-place editor

Type:
  • object
Properties:
Name Type Description
setUp function

Starts the in-place editor on the passed Editable

tearDown function

Stops the in-place editor on the passed Editable

Source:
editors/editor.js

InteractionConfig

Type:
  • object
Properties:
Name Type Description
onOverlayHover function

The handler that gets executed when an overlay is hovered

onOverlayClick function

The handler that gets executed when an overlay is clicked

onOverlayFastDblClick function

The handler that gets executed when an overlay is fastly double clicked

onOverlaySlowDblClick function

The handler that gets executed when an overlay is slowly double clicked

onOutsideOverlayClick function

The handler that gets executed when a click outside of any overlay occurs

ignoreGroupSelection boolean

Should the group selection be ignored

Source:
selection.js

LayerConfig

Represent a Layer Configuration object

Type:
  • Object
Properties:
Name Type Argument Description
name string

The name identifier of the Layer.

iconClass string

The class of the icon that represents the Layer in the Layer selector.

title string

The displayed title of the Layer.

overlayConstructor Granite.author.ui.Overlay <optional>

The constructor for the Overlays representing Editables.

toolbarConstructor Granite.author.ui.Toolbar <optional>

The constructor for the Toolbar for Editables.

editableActions Object <optional>

The configuration object for the low-level Granite.author.ui.EditableActions on Editables.

toolbarActions Object <optional>

The configuration object for the high-level Granite.author.ui.ToolbarActions on Editables.

sidePanel Object <optional>

The SidePanel configuration object.

Properties
Name Type Argument Description
setUp function <optional>

The function that sets up the SidePanel.

tearDown function <optional>

The function that tears down the SidePanel .

findEditables function <optional>

The function used to provide a list of Editables. If not provided, the ContentFrame will a the default function.

interactions InteractionConfig <optional>

The configuration object describing interactions with Overlays.

Source:
layers/Layer.js

LayerManagerConfig

Represent a LayerManager Configuration object

Type:
  • object
Properties:
Name Type Argument Description
layerOrder Array.<string> <optional>

Order in which the layers should be displayed

getDefaultLayer function <optional>

Should return the name of the Layer to activate. Will be called when Granite.author.LayerManager is initializing.

Source:
layers/LayerManager.js