ScreensaverElement | Photo Screensaver

Polymer element to display a screensaver

Hierarchy

BaseElement
- ScreensaverElement

Index

Constructors

constructor

Events

onImageError

Properties

Accessors

template

Constructors

Static constructor

new ScreensaverElement(): ScreensaverElement

Inherited from (Anonymous class).__constructor
- Defined in node_modules/@opus1269/common-custom-elements/src/mixins/i8n_mixin.ts:25
Returns ScreensaverElement

Events

Protected onImageError

onImageError(ev: CustomEvent): Promise<void>

- Defined in elements/screensaver-element/screensaver-element.ts:528
An image failed to load

Parameters
- ev: CustomEvent
Returns Promise<void>

Properties

Protected MAX_SLIDES

MAX_SLIDES: 10 = 10

Maximum number of slides to create

@remarks Actual number will be the smaller of this and the total number of photos

Protected aniType

aniType: number = ScreensaverElement.getAniType()

Type for between photo animation

Protected delayTime

delayTime: number = 1500

Delay before showing first slide in milli secs

Protected noPhotos

noPhotos: boolean = false

Flag to indicate if we have no valid photos

Protected pages

pages: NeonAnimatedPagesElement

NeonAnimatedPages

Protected paused

paused: boolean = false

Flag to indicate if slideshow is paused

Protected photos

photos: SSPhoto[] = []

Array of SSPhoto in the views

Protected repeatTemplate

repeatTemplate: DomRepeat

Slide repeat template

Protected timeLabel

timeLabel: string = ""

Label for current time

Protected viewType

viewType: number = ScreensaverElement.getViewType()

Type for photo appearance

Accessors

Static template

get template(): HTMLTemplateElement

- Defined in elements/screensaver-element/screensaver-element.ts:649
Returns HTMLTemplateElement

Methods

connectedCallback

connectedCallback(): void

- Defined in elements/screensaver-element/screensaver-element.ts:195
Called when the element is added to a document. Can be called multiple times during the lifetime of an element.

Returns void

disconnectedCallback

disconnectedCallback(): void

- Defined in elements/screensaver-element/screensaver-element.ts:206
Called when the element is removed from a document. Can be called multiple times during the lifetime of an element.

Returns void

findLoadedPhoto

findLoadedPhoto(idx: number): number

- Defined in elements/screensaver-element/screensaver-element.ts:325
Try to find a slide photo that has finished loading

Parameters
- idx: number
  
  index into photos
Returns number

index into photos, -1 if none are loaded

Protected fireEvent

fireEvent(name: string, detailValue?: any): void

Inherited from BaseElement.fireEvent
- Defined in node_modules/@opus1269/common-custom-elements/src/base-element/base-element.ts:46
Dispatch an event

Parameters
- name: string
  
  event name
- Optional detailValue: any
  
  optional value
Returns void

getMaxSlideCount

getMaxSlideCount(): number

- Defined in elements/screensaver-element/screensaver-element.ts:280
Get max number of slides

Returns number

getPhotos

getPhotos(): SSPhoto[]

- Defined in elements/screensaver-element/screensaver-element.ts:285
Get the photos currently in the slides

Returns SSPhoto[]

getSelectedPhoto

getSelectedPhoto(): undefined | SSPhoto

- Defined in elements/screensaver-element/screensaver-element.ts:294
Get the selected photo

Returns undefined | SSPhoto

The selected photo, undefined if non selected

getSelectedSlideIndex

getSelectedSlideIndex(): number

- Defined in elements/screensaver-element/screensaver-element.ts:377
Get the index of the selected slide

Returns number

The index of the current slide, -1 if none selected

getSlide

getSlide(idx: number): ScreensaverSlideElement

- Defined in elements/screensaver-element/screensaver-element.ts:407
Get the slide at the given index

Parameters
- idx: number
Returns ScreensaverSlideElement

getSlideCount

getSlideCount(): number

- Defined in elements/screensaver-element/screensaver-element.ts:402
Get the number of slides

Returns number

Protected hasUsablePhoto

hasUsablePhoto(): boolean

- Defined in elements/screensaver-element/screensaver-element.ts:467
Do we have a photo that is loaded

Returns boolean

isNoPhotos

isNoPhotos(): boolean

- Defined in elements/screensaver-element/screensaver-element.ts:413
Do we have usable photos

Returns boolean

isSelectedSlideIndex

isSelectedSlideIndex(idx: number): boolean

- Defined in elements/screensaver-element/screensaver-element.ts:364
Is the given idx the selected slide

Parameters
- idx: number
  
  index into photos
Returns boolean

true if selected

launch

launch(): Promise<void>

- Defined in elements/screensaver-element/screensaver-element.ts:231
Launch the slide show

Returns Promise<void>

Protected pausedChanged

pausedChanged(newValue: boolean, oldValue: boolean): void

- Defined in elements/screensaver-element/screensaver-element.ts:453
Simple Observer: Paused state changed

Parameters
- newValue: boolean
  
  new value
- oldValue: boolean
  
  old value
Returns void

ready

ready(): Promise<void>

- Defined in elements/screensaver-element/screensaver-element.ts:217
Called during Polymer-specific element initialization. Called once, the first time the element is attached to the document.

Returns Promise<void>

Protected replaceAllPhotos

replaceAllPhotos(): void

- Defined in elements/screensaver-element/screensaver-element.ts:484
Replace the photo in all the slides but the current animation pair

Returns void

replacePhoto

replacePhoto(photo: SSPhoto, idx: number): void

- Defined in elements/screensaver-element/screensaver-element.ts:309
Replace the slide photo at the given index

Parameters
- photo: SSPhoto
  
  new photo
- idx: number
  
  index to replace
Returns void

setNoPhotos

setNoPhotos(): void

- Defined in elements/screensaver-element/screensaver-element.ts:418
Set the state when no photos are available

Returns void

setPaused

setPaused(paused: boolean): void

- Defined in elements/screensaver-element/screensaver-element.ts:423
Set the paused state of the slideshow

Parameters
- paused: boolean
Returns void

setSelectedSlideIndex

setSelectedSlideIndex(idx: number): void

- Defined in elements/screensaver-element/screensaver-element.ts:395
Set the selected index of the pages

Parameters
- idx: number
  
  slide index
Returns void

Protected setTimeLabel

setTimeLabel(): void

- Defined in elements/screensaver-element/screensaver-element.ts:438
Set the time label

Returns void

Protected setupTime

setupTime(): void

- Defined in elements/screensaver-element/screensaver-element.ts:428
Setup timer for time label

Returns void

Protected updateAllUrls

updateAllUrls(photos: IPhoto[]): void

- Defined in elements/screensaver-element/screensaver-element.ts:506
Update the url in all the slides

Parameters
- photos: IPhoto[]
  
  Photos whose url's have changed
Returns void

Static Protected getAniType

getAniType(): number

- Defined in elements/screensaver-element/screensaver-element.ts:115
Get between photo's animation

Returns number

Static Protected getViewType

getViewType(): number

- Defined in elements/screensaver-element/screensaver-element.ts:105
Get slide appearance

Returns number

Static localize

localize(name: string, def?: undefined | string): string

Inherited from (Anonymous class).localize
- Defined in node_modules/@opus1269/common-custom-elements/src/mixins/i8n_mixin.ts:37
Localize a string

Parameters
- name: string
  
  name from _locales
- Optional def: undefined | string
  
  optional default value if name not found
Returns string

Static Protected setZoom

setZoom(): Promise<void>

- Defined in elements/screensaver-element/screensaver-element.ts:125
Set the window zoom factor to 1.0

Returns Promise<void>

Static Protected setupFaceDetect

setupFaceDetect(): Promise<void>

- Defined in elements/screensaver-element/screensaver-element.ts:141
Setup face detection

throws

An error if failed to initialize face-api.js

Returns Promise<void>

Hierarchy

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

Static constructor

Returns ScreensaverElement

Events

Protected onImageError

Parameters

ev: CustomEvent

Returns Promise<void>

Properties

Protected MAX_SLIDES

Protected aniType

Protected delayTime

Protected noPhotos

Protected pages

Protected paused

Protected photos

Protected repeatTemplate

Protected timeLabel

Protected viewType

Accessors

Static template

Returns HTMLTemplateElement

Methods

connectedCallback

Returns void

disconnectedCallback

Returns void

findLoadedPhoto

Parameters

idx: number

Returns number

Protected fireEvent

Parameters

name: string

Optional detailValue: any

Returns void

getMaxSlideCount

Returns number

getPhotos

Returns SSPhoto[]

getSelectedPhoto

Returns undefined | SSPhoto

getSelectedSlideIndex

Returns number

getSlide

Parameters

idx: number

Returns ScreensaverSlideElement

getSlideCount

Returns number

Protected hasUsablePhoto

Returns boolean

isNoPhotos

Returns boolean

isSelectedSlideIndex

Parameters

idx: number

Returns boolean

launch

Returns Promise<void>

Protected pausedChanged

Parameters

newValue: boolean

oldValue: boolean

Returns void

ready

Returns Promise<void>

Protected replaceAllPhotos

Returns void

replacePhoto

Parameters

photo: SSPhoto

idx: number