Linker are made to show a line between two point it will automatically adjust its size, position, and rotation.

How to Initialize any Linker?


Linker have to be handle by overlays with several functions.

Class Details

Functions:


       Initialization & Main Functions

Name

Arguments

Return

Description

Init
  • String: BaseID - HMTL ID defining the position in the DOM of the linker.
  • String: RegistryName - Name that define this popup, all children IDs will start by this.

VOID

This function Initialized every part of the viewer: HMTL, CSS, Data, Events, etc...

It will be generated in the defined ID and all HTML IDs used for this  will start by the RegistryName defined in arguments.

Launch
  • None

VOID

N/A

SetPos
  • Integer: X
  • Integer: Y

VOID

Set the starting point based on overlay size and position.

SetOffset
  • Integer: OffsetX
  • Integer: OffsetY

VOID

Set the finishing point based on overlay size and position.

Remove
  • None

VOID

Delete this linker from DOM



Private Details


All private details are usable but its recommended to not use any of those. It might modify the proper functioning of the class.


Variables (Members):


       Main Members

Name

Type

Default Value

Description

id

String

undefined

Global HMTL Id of the viewer (# + name).

registryName

String

undefined

Name of this widget.

basedId

String

undefined

Where it is located is the existing DOM (its parent).


Information

Name

Type

Default Value

Description

position

Class

x: 0 and y: 0 and fromRight: false and fromBottom: false

Hold the actual position of the widget.


Compatibility


LANGUAGE CLASS: Not compatible.

Created with the Personal Edition of HelpNDoc: Generate EPub eBooks with ease