parameter |
data type |
description |
start_timeout |
[ number ] |
(in msec) Timeout to wait before start code execution. Usefull for generated by hosting web-constructors sites (Wix, ..) |
default_url |
[ string ] |
(Full URL) Default iframe URL. In case when workspace owner wants to ADD all new users to his contact list he can put here his "EMBEDDED User Profile Link" from ROOT NINJA web site.
Go to ROOT NINJA web. Open profile page https://web.nynja.net/profile and COPY Embedded link from there.
|
parent |
[ Html Dom ELement ] |
Dom element where user wants to add widget and frame elements (!! fullscreen elements will be added to BODY in any case) |
workspace_id |
[ string ] |
id of "your NINJA workspace"
should be provided ONLY if it is registered with NINJA support,
otherwise EMAIL messages will have Default NINJA content and URLS ! Keep it EMPTY if you don't have registered "workspace_id"
|
enterprise_id |
[ string ] |
id for enterprise, should be registered with Ninja support.
This is mandatory for white labelling of app.
|
frame_id |
[ string ] |
id of DOM iframe element in HTML. (Change it in case if you use your OWN iframe element) |
frame_elm |
[ Html Dom Element ] |
Users iframe element. (used in case when user inserted his iframe in some sepcific place and want to use it) |
to_create_html |
[ boolean ] |
to generate all HTML elements: widget buttons, iframe, .. |
to_show_widget_button |
[ boolean ] |
to show widget elements : button,.. |
to_show_frame_onstart |
[ boolean ] |
by default iframe will be showed and web page will be loaded in frame |
to_load_nynja_onstart |
[ boolean ] |
froom start even if frame not showed web page will be loaded in frame |
view_mode |
[ string ] |
Defines how frame will be showed
fullscreen |
frame covers all page. page scroll is locked while widget frame is opened |
static |
frame is inside page elements. page scroll enabled |
popup |
frame is fixed and floating above page. page scroll enabled |
modal |
frame floating above page and scrolls with page |
|
add_css_code |
[ string ] |
additional CSS code user can add to page |
frame_style |
[ string ] |
additional CSS for FRAME (applies to visible/opened frame) |
frame_position |
[ string ] |
Defines position of frame on the page.
center |
in the middle of page |
center_top |
horrizontal: center; vertical: top; |
center_bottom |
horrizontal: center; vertical: bottom; |
left_top |
horrizontal: left; vertical: top; |
left_middle |
horrizontal: left; vertical: middle; |
left_bottom |
horrizontal: left; vertical: bottom; |
right_top |
horrizontal: left; vertical: top; |
right_middle |
horrizontal: left; vertical: middle; |
right_bottom |
horrizontal: left; vertical: bottom; |
|
widget_style |
[ string ] |
additional user CSS fro widget button wrapper |
widget_position |
[ string ] |
Defines if widget button will appear above or under frame or in the corner of page
top |
above the frame |
bottom |
under the frame |
right_bottom |
in the right_bottom page corner |
left_bottom |
in the left_bottom page corner |
|
to_scroll |
[ boolean ] |
In some cases frame could be out of current view, so page should scroll to frame pposition |
special_mode |
[ string ] |
Specialmods of widget work, for some specific cases
wix |
mode for "Wix"-generated sites. |
|