Class SkeletonCarousel

Builds a carousel like SelectorCarousel but does not wait for the circuits to load, sets up a placeholders and inserts data when loaded, used for the Tutorial on the learn page (in code SelectPage) in the TutorialSelector

Hierarchy (View Summary)

SelectorCarousel
- SkeletonCarousel
  - ScannerCarousel

Constructors

constructor

new SkeletonCarousel(
    parent: any,
    circuitFiles: any,
    identifier: any,
    parentSelector: any,
): SkeletonCarousel
Parameters
- parent: any
- circuitFiles: any
- identifier: any
- parentSelector: any
Returns SkeletonCarousel
Overrides SelectorCarousel.constructor
- Defined in src/scripts/dataObjects/skeletonCarousel.js:7

Properties

bootstrapCarousel

bootstrapCarousel: Carousel

carousel

carousel: HTMLDivElement

circuitFiles

circuitFiles: any

circuitNameContainer

circuitNameContainer: HTMLDivElement

circuitSet

circuitSet: CircuitSet

imgOverlay

imgOverlay: HTMLDivElement

indicatorsDiv

indicatorsDiv: HTMLDivElement

initializationStarted

initializationStarted: boolean = false

innerCarousel

innerCarousel: HTMLDivElement

isInitialized

isInitialized: boolean = false

nextBtn

nextBtn: HTMLDivElement

overviewBtn

overviewBtn: HTMLButtonElement

overviewBtnDiv

overviewBtnDiv: HTMLDivElement

overViewModalBody

overViewModalBody: HTMLDivElement

parent

parent: Selector

parentDiv

parentDiv: HTMLDivElement

prevBtn

prevBtn: HTMLDivElement

startBtn

startBtn: HTMLButtonElement

Accessors

circuitMaps

get circuitMaps(): CircuitMap[]
Returns CircuitMap[]
Inherited from SelectorCarousel.circuitMaps
- Defined in src/scripts/dataObjects/selectorCarousel.js:46

identifier

get identifier(): {
    capacitor: string;
    inductor: string;
    kirchhoff: string;
    magnetic: string;
    mixed: string;
    quickstart: string;
    resistor: string;
    symbolic: string;
    wheatstone: string;
}
Returns {
    capacitor: string;
    inductor: string;
    kirchhoff: string;
    magnetic: string;
    mixed: string;
    quickstart: string;
    resistor: string;
    symbolic: string;
    wheatstone: string;
}
Inherited from SelectorCarousel.identifier
- Defined in src/scripts/dataObjects/selectorCarousel.js:42

indicatorContainerElement

get indicatorContainerElement(): Element
Returns Element
Inherited from SelectorCarousel.indicatorContainerElement
- Defined in src/scripts/dataObjects/selectorCarousel.js:76

overviewBtnElement

get overviewBtnElement(): HTMLDivElement
Returns HTMLDivElement
Inherited from SelectorCarousel.overviewBtnElement
- Defined in src/scripts/dataObjects/selectorCarousel.js:62

overviewItemElement

get overviewItemElement(): string
Returns string
Inherited from SelectorCarousel.overviewItemElement
- Defined in src/scripts/dataObjects/selectorCarousel.js:50

Methods

addVoltFreqOverlay

addVoltFreqOverlay(circuitMap: any): any
Parameters
- circuitMap: any
Returns any
Inherited from SelectorCarousel.addVoltFreqOverlay
- Defined in src/scripts/dataObjects/selectorCarousel.js:238

afterCircuitsLoaded

afterCircuitsLoaded(): Promise<void>
Returns Promise<void>
- Defined in src/scripts/dataObjects/skeletonCarousel.js:62

appendChildren

appendChildren(newParent: any, oldParent: any): void
Parameters
- newParent: any
- oldParent: any
Returns void
- Defined in src/scripts/dataObjects/skeletonCarousel.js:55

carouselItem

carouselItem(id: any, identifier: any): HTMLElement
Parameters
- id: any
- identifier: any
Returns HTMLElement
Inherited from SelectorCarousel.carouselItem
- Defined in src/scripts/dataObjects/selectorCarousel.js:228

carouselSlideChanged

carouselSlideChanged(event: any, indicators: any): void
Parameters
- event: any
- indicators: any
Returns void
Inherited from SelectorCarousel.carouselSlideChanged
- Defined in src/scripts/dataObjects/selectorCarousel.js:287

circuitNameContainerElement

circuitNameContainerElement(text: any): HTMLElement
Parameters
- text: any
Returns HTMLElement
Inherited from SelectorCarousel.circuitNameContainerElement
- Defined in src/scripts/dataObjects/selectorCarousel.js:85

createCarousel

createCarousel(): Element
Returns Element
Inherited from SelectorCarousel.createCarousel
- Defined in src/scripts/dataObjects/selectorCarousel.js:98

generateOverviewGrid

generateOverviewGrid(circuitMaps: CircuitMap[]): HTMLDivElement
Parameters
- circuitMaps: CircuitMap[]
  {Array}
Returns HTMLDivElement
Inherited from SelectorCarousel.generateOverviewGrid
- Defined in src/scripts/dataObjects/selectorCarousel.js:179

getCircuitFileName

getCircuitFileName(idx: any): string
Parameters
- idx: any
Returns string
Inherited from SelectorCarousel.getCircuitFileName
- Defined in src/scripts/dataObjects/selectorCarousel.js:272

getIdMainCarousel

getIdMainCarousel(event: any): any
Parameters
- event: any
Returns any
Inherited from SelectorCarousel.getIdMainCarousel
- Defined in src/scripts/dataObjects/selectorCarousel.js:198

hideImgOverlay

hideImgOverlay(): void
Returns void
Inherited from SelectorCarousel.hideImgOverlay
- Defined in src/scripts/dataObjects/selectorCarousel.js:137

indicatorBtn

indicatorBtn(idx: any): Element
Parameters
- idx: any
Returns Element
Inherited from SelectorCarousel.indicatorBtn
- Defined in src/scripts/dataObjects/selectorCarousel.js:91

init

init(svgFn: Function): void
Initializes the carousel with placeholders, does not wait for the circuits to load, sets up a placeholder
Parameters
- svgFn: Function
  {function} a function that returns the innerHTML of the svg element of the carousel item, used to display a placeholder svg until the actual circuit data is loaded
Returns void
Overrides SelectorCarousel.init
- Defined in src/scripts/dataObjects/skeletonCarousel.js:17

selectCircuitInCarousel

selectCircuitInCarousel(): void
Returns void
Inherited from SelectorCarousel.selectCircuitInCarousel
- Defined in src/scripts/dataObjects/selectorCarousel.js:404

setDataBsScheme

setDataBsScheme(): void
Returns void
Inherited from SelectorCarousel.setDataBsScheme
- Defined in src/scripts/dataObjects/selectorCarousel.js:420

setupOverviewModalCircuit

setupOverviewModalCircuit(circuitMap: CircuitMap, svg: SVGElement): void
Parameters
- circuitMap: CircuitMap
  {CircuitMap}
- svg: SVGElement
  {SVGElement}
Returns void
Inherited from SelectorCarousel.setupOverviewModalCircuit
- Defined in src/scripts/dataObjects/selectorCarousel.js:255

showImgOverlay

showImgOverlay(): void
Returns void
Inherited from SelectorCarousel.showImgOverlay
- Defined in src/scripts/dataObjects/selectorCarousel.js:152

startBtnFn

startBtnFn(event: Event): void
Parameters
- event: Event
  {Event}
Returns void
Inherited from SelectorCarousel.startBtnFn
- Defined in src/scripts/dataObjects/selectorCarousel.js:205

startCircuit

startCircuit(index: any): void
Parameters
- index: any
Returns void
Inherited from SelectorCarousel.startCircuit
- Defined in src/scripts/dataObjects/selectorCarousel.js:211

templateItem

templateItem(): Element
Returns Element
Inherited from SelectorCarousel.templateItem
- Defined in src/scripts/dataObjects/selectorCarousel.js:308

templateItemInnerHtml

templateItemInnerHtml(): string
Returns string
Inherited from SelectorCarousel.templateItemInnerHtml
- Defined in src/scripts/dataObjects/selectorCarousel.js:318

toggleImgOverlay

toggleImgOverlay(): void
Returns void
Inherited from SelectorCarousel.toggleImgOverlay
- Defined in src/scripts/dataObjects/selectorCarousel.js:167

updateColor

updateColor(): void
Returns void
Inherited from SelectorCarousel.updateColor
- Defined in src/scripts/dataObjects/selectorCarousel.js:424

updateOverviewBody

updateOverviewBody(): void
Returns void
Inherited from SelectorCarousel.updateOverviewBody
- Defined in src/scripts/dataObjects/selectorCarousel.js:413

Class SkeletonCarousel

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SkeletonCarousel

Properties

bootstrapCarousel

carousel

circuitFiles

circuitNameContainer

circuitSet

imgOverlay

indicatorsDiv

initializationStarted

innerCarousel

isInitialized

nextBtn

overviewBtn

overviewBtnDiv

overViewModalBody

parent

parentDiv

prevBtn

startBtn

Accessors

circuitMaps

Returns CircuitMap[]

identifier

Returns { capacitor: string; inductor: string; kirchhoff: string; magnetic: string; mixed: string; quickstart: string; resistor: string; symbolic: string; wheatstone: string;}

indicatorContainerElement

Returns Element

overviewBtnElement

Returns HTMLDivElement

overviewItemElement

Returns string

Methods

addVoltFreqOverlay

Parameters

Returns any

afterCircuitsLoaded

Returns Promise<void>

appendChildren

Parameters

Returns void

carouselItem

Parameters

Returns HTMLElement

carouselSlideChanged

Parameters

Returns void

circuitNameContainerElement

Parameters

Returns HTMLElement

createCarousel

Returns Element

generateOverviewGrid

Parameters

Returns HTMLDivElement

getCircuitFileName

Parameters

Returns string

getIdMainCarousel

Parameters

Returns any

hideImgOverlay

Returns void

indicatorBtn

Parameters

Returns Element

init

Parameters

Returns void

selectCircuitInCarousel

Returns void

Returns {
capacitor: string;
inductor: string;
kirchhoff: string;
magnetic: string;
mixed: string;
quickstart: string;
resistor: string;
symbolic: string;
wheatstone: string;
}