API Docs for: 1.0.0
Show:

LADS.Layout.Artmode Class

The artwork viewer, which contains a sidebar with tools and thumbnails as well as a central area for the deepzoom image.

Constructor

LADS.Layout.Artmode

(
  • options
)
Object

Parameters:

  • options Object

    some options for the artwork viewer page

Returns:

Object:

some public methods

Methods

buttonHandler

(
  • evt
  • direction
)

Click handler for button in given direction; a wrapper around doManip that also executes doManip in an interval if the user is holding down a button

Parameters:

  • evt Object

    the event object

  • direction String

    the direction in which to move the artwork

createButton

(
  • id
  • imgPath
  • left
  • top
)
JQuery obj

Create a seadragon control button

Parameters:

  • id String

    the id for the new button

  • imgPath String

    the path to the button's image

  • left Number

    css left property for button

  • top Number

    css top property for button

Returns:

JQuery obj:

the button

createMediaButton

(
  • container
  • media
)

Creates a thumbnail button for an associated media

Parameters:

  • container JQuery obj

    the element to which we'll append the button

  • media Object

    an associated media object (from AnnotatedImage)

createSeadragonControls

()

Add controls and key handlers for manual Seadragon manipulation

createTourButton

(
  • container
  • tour
)

Creates a tour thumbnail button

Parameters:

  • container JQuery obj

    the element to which we'll append this button

  • tour Doq

    the tour doq

doManip

(
  • evt
  • direction
)

Do fixed manipulation in response to seadragon controls or key presses

Parameters:

  • evt Object

    the event object

  • direction String

    the direction in which to move the artwork

drawPinHelper

(
  • e
)

Helper function to draw pushpin on location history map when a location's info box is clicked

Parameters:

  • e Object

    event data related to a location

histOnClick

()

Click handler to expand location history window

init

()

Initiate artmode with a root, artwork image and a sidebar on the left

() JQuery obj

Return art viewer root element

Returns:

JQuery obj:

root jquery object

keyHandler

(
  • evt
  • direction
)

Keydown handler for artwork manipulation; wrapper around doManip that first prevents default key behaviors

Parameters:

  • evt Object

    the event object

  • direction String

    the direction in which to move the artwork

makeSidebar

()

Makes the artwork viewer sidebar

mediaClicked

(
  • media
)

Generates a click handler for a specific associated media object

Parameters:

  • media Object

    the associated media object (from AnnotatedImage)

prepMap

()

A callback function to populate the location history map after it has been created

toggleLocationPanel

()

Toggles location panel when locHistoryContainer or toggler is clicked

(
  • callback
)

Make the map for location History.

Parameters:

  • callback Function

    function to be called when map making is complete