PMA.UI Documentation by Pathomation

Filename

Filename

Creates a control to display the filename of a slide

Constructor

new Filename(opt_options)

Source:
Parameters:
Name Type Description
opt_options object Options to initialize
Properties
Name Type Attributes Description
filename string | PMA.UI.View.Viewport~filenameCallback | undefined How to show the filename. If a string is passed this is displayed. If a callback function is passed this is called to get the filaname to show. If this is ommited the filename is automatically fetched via the slide info
onClick string The event to call when the filename is clicked
collapsed boolean <optional>
 Whether the control starts collapsed
collapseLabel string <optional>
 The label to show when collapsed
stateManager Object <optional>
 The state manager to keep settings in sync

Classes

Filename

Methods

getCollapsed() → {boolean}

Source:
Gets the collapsed state of the control
Returns:
True if the control is currently collapsed
Type
boolean

setCollapsed(collapsed)

Source:
Sets the collapsed state of the control
Parameters:
Name Type Description
collapsed boolean True to collapse the control, otherwise false