forked from 0x2620/oxjs
update widget documentation (arguments first)
This commit is contained in:
parent
daec992536
commit
a0867f0da6
81 changed files with 250 additions and 251 deletions
|
|
@ -2,6 +2,14 @@
|
|||
|
||||
/*@
|
||||
Ox.AnnotationFolder <f> AnnotationFolder Object
|
||||
options <o> Options object
|
||||
editable <b|false> If true, annotations can be added
|
||||
id <s> id
|
||||
items <a|[]> items
|
||||
title <s> title
|
||||
type <s|'text'> panel type
|
||||
width <n|0>
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.CollapsePanel> AnnotationFolder Object
|
||||
add <!> add
|
||||
blur <!> blur
|
||||
|
|
@ -19,14 +27,6 @@ Ox.AnnotationFolder <f> AnnotationFolder Object
|
|||
submit <!> submit
|
||||
togglelayer <!> togglelayer
|
||||
togglewidget <!> togglewidget
|
||||
options <o> Options object
|
||||
editable <b|false> If true, annotations can be added
|
||||
id <s> id
|
||||
items <a|[]> items
|
||||
title <s> title
|
||||
type <s|'text'> panel type
|
||||
width <n|0>
|
||||
self <o> shared private variable
|
||||
@*/
|
||||
|
||||
Ox.AnnotationFolder = function(options, self) {
|
||||
|
|
|
|||
|
|
@ -2,23 +2,6 @@
|
|||
|
||||
/*@
|
||||
Ox.AnnotationPanel <f> Video Annotation Panel
|
||||
([options[, self]]) -> <o:Ox.SplitPanel> AnnotationPanel Object
|
||||
add <!> add
|
||||
annotationsID <!> annotationsID
|
||||
blur <!> blur
|
||||
change <!> change
|
||||
define <!> define
|
||||
edit <!> edit
|
||||
findannotations <!> findannotations
|
||||
find <!> find
|
||||
focus <!> focus
|
||||
info <!> info
|
||||
open <!> open
|
||||
remove <!> remove
|
||||
resize <!> resize
|
||||
submit <!> submit
|
||||
togglelayer <!> togglelayer
|
||||
toggle* <!> toggle*
|
||||
options <o> Options object
|
||||
calendarSize <n|256> calendar size
|
||||
clickLink <f|null> click link callback
|
||||
|
|
@ -36,7 +19,24 @@ Ox.AnnotationPanel <f> Video Annotation Panel
|
|||
showUsers <b|false> if true show user
|
||||
sort <s|'position'> position, start, text
|
||||
width <n|256> panel width
|
||||
self <o> shared private variable
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.SplitPanel> AnnotationPanel Object
|
||||
add <!> add
|
||||
annotationsID <!> annotationsID
|
||||
blur <!> blur
|
||||
change <!> change
|
||||
define <!> define
|
||||
edit <!> edit
|
||||
findannotations <!> findannotations
|
||||
find <!> find
|
||||
focus <!> focus
|
||||
info <!> info
|
||||
open <!> open
|
||||
remove <!> remove
|
||||
resize <!> resize
|
||||
submit <!> submit
|
||||
togglelayer <!> togglelayer
|
||||
toggle* <!> toggle*
|
||||
@*/
|
||||
|
||||
Ox.AnnotationPanel = function(options, self) {
|
||||
|
|
|
|||
|
|
@ -2,12 +2,12 @@
|
|||
|
||||
/*@
|
||||
Ox.BlockVideoTimeline <f> Block Video Timeline
|
||||
options <o> Options
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.Element> Block Video Timeline
|
||||
edit <!> edit
|
||||
select <!> select
|
||||
position <!> position
|
||||
options <o> Options
|
||||
self <o> Shared private variable
|
||||
@*/
|
||||
Ox.BlockVideoTimeline = function(options, self) {
|
||||
|
||||
|
|
|
|||
|
|
@ -2,10 +2,10 @@
|
|||
|
||||
/*@
|
||||
Ox.LargeVideoTimeline <f> LargeTimeline Object
|
||||
([options[, self]]) -> <o:Ox.Element> LargeTimeline Object
|
||||
options <o> Options object
|
||||
self <o> shared private variable
|
||||
position <!> position
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.Element> LargeTimeline Object
|
||||
position <!> position
|
||||
@*/
|
||||
|
||||
Ox.LargeVideoTimeline = function(options, self) {
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
/*@
|
||||
Ox.SmallVideoTimeline <f> Small video timeline
|
||||
options <o> Options
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.Element> Small video timeline
|
||||
position <!> position
|
||||
@*/
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
|
||||
/*@
|
||||
Ox.SmallVideoTimelineImage <f> Small Video Timeline Image
|
||||
(options[, self]) -> <o:Ox.Element> Small Video Timeline Image
|
||||
options <o> Options
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.Element> Small Video Timeline Image
|
||||
@*/
|
||||
Ox.SmallVideoTimelineImage = function(options, self) {
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
/*@
|
||||
Ox.VideoEditor <f> VideoEditor Object
|
||||
options <o> Options object
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.SplitPanel> VideoEditor Object
|
||||
addannotation <!> addannotation
|
||||
annotationsfont <!> annotationsfont
|
||||
|
|
@ -37,9 +39,6 @@ Ox.VideoEditor <f> VideoEditor Object
|
|||
togglelayer <!> togglelayer
|
||||
togglemap <!> togglemap
|
||||
volume <!> volume
|
||||
options <o> Options object
|
||||
annotationsCalendarSize <n|256>
|
||||
self <o> shared private variable
|
||||
@*/
|
||||
|
||||
// fixme: should be VideoAnnotationEditor
|
||||
|
|
|
|||
|
|
@ -2,13 +2,13 @@
|
|||
|
||||
/*@
|
||||
Ox.VideoEditorPlayer <f> VideoEditorPlayer Object
|
||||
options <o> Options object
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.Element> VideoEditorPlayer Object
|
||||
change <!> change
|
||||
playing <!> playing
|
||||
set <!> set
|
||||
togglesize <!> togglesize
|
||||
options <o> Options object
|
||||
self <o> shared private variable
|
||||
@*/
|
||||
|
||||
Ox.VideoEditorPlayer = function(options, self) {
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
/*@
|
||||
Ox.VideoElement <f> VideoElement Object
|
||||
options <o> Options object
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.Element> VideoElement Object
|
||||
loadedmetadata <!> loadedmetadata
|
||||
pointschange <!> pointschange
|
||||
|
|
@ -9,8 +11,6 @@ Ox.VideoElement <f> VideoElement Object
|
|||
seeking <!> seeking
|
||||
sizechange <!> sizechange
|
||||
ended <!> ended
|
||||
options <o> Options object
|
||||
self <o> shared private variable
|
||||
@*/
|
||||
|
||||
Ox.VideoElement = function(options, self) {
|
||||
|
|
|
|||
|
|
@ -2,7 +2,15 @@
|
|||
|
||||
/*@
|
||||
Ox.VideoPanel <f> VideoPanel Object
|
||||
options <o> Options object
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.SplitPanel> VideoPanel Object
|
||||
annotationsfont <!> annotationsfont
|
||||
annotationsrange <!> annotationsrange
|
||||
annotationssize <!> annotationssize
|
||||
annotationssort <!> annotationssort
|
||||
censored <!> censored
|
||||
downloadvideo <!> downloadvideo
|
||||
find <!> find
|
||||
info <!> info
|
||||
key_* <!> key_*
|
||||
|
|
@ -20,14 +28,6 @@ Ox.VideoPanel <f> VideoPanel Object
|
|||
togglemap <!> togglemap
|
||||
toggletimeline <!> toggletimeline
|
||||
volume <!> volume
|
||||
options <o> Options object
|
||||
self <o> shared private variable
|
||||
annotationsfont <!> annotationsfont
|
||||
annotationsrange <!> annotationsrange
|
||||
annotationssize <!> annotationssize
|
||||
annotationssort <!> annotationssort
|
||||
censored <!> censored
|
||||
downloadvideo <!> downloadvideo
|
||||
@*/
|
||||
|
||||
Ox.VideoPanel = function(options, self) {
|
||||
|
|
|
|||
|
|
@ -2,28 +2,6 @@
|
|||
|
||||
/*@
|
||||
Ox.VideoPlayer <f> Generic Video Player
|
||||
([options[, self]]) -> <o:Ox.Element> Video Player
|
||||
censored <!> censored
|
||||
close <!> close
|
||||
download <!> download
|
||||
ended <!> ended
|
||||
find <!> find
|
||||
fullscreen <!> fullscreen
|
||||
gotopoint <!> gotopoint
|
||||
loadedmetadata <!> loadedmetadata
|
||||
muted <!> muted
|
||||
open <!> open
|
||||
paused <!> paused
|
||||
playing <!> playing
|
||||
position <!> position
|
||||
resolution <!> resolution
|
||||
scale <!> scale
|
||||
select <!> select
|
||||
setpoint <!> setpoint
|
||||
size <!> size
|
||||
subtitles <!> subtitles
|
||||
volume <!> volume
|
||||
zap <!> zap
|
||||
options <o> Options
|
||||
annotations <[]> Array of annotations
|
||||
id <s> Optional id
|
||||
|
|
@ -95,6 +73,28 @@ Ox.VideoPlayer <f> Generic Video Player
|
|||
volume <n|1> Volume (0-1)
|
||||
width <n|256> Width in px
|
||||
self <o> shared private variable
|
||||
([options[, self]]) -> <o:Ox.Element> Video Player
|
||||
censored <!> censored
|
||||
close <!> close
|
||||
download <!> download
|
||||
ended <!> ended
|
||||
find <!> find
|
||||
fullscreen <!> fullscreen
|
||||
gotopoint <!> gotopoint
|
||||
loadedmetadata <!> loadedmetadata
|
||||
muted <!> muted
|
||||
open <!> open
|
||||
paused <!> paused
|
||||
playing <!> playing
|
||||
position <!> position
|
||||
resolution <!> resolution
|
||||
scale <!> scale
|
||||
select <!> select
|
||||
setpoint <!> setpoint
|
||||
size <!> size
|
||||
subtitles <!> subtitles
|
||||
volume <!> volume
|
||||
zap <!> zap
|
||||
@*/
|
||||
|
||||
Ox.VideoPlayer = function(options, self) {
|
||||
|
|
|
|||
|
|
@ -2,10 +2,10 @@
|
|||
|
||||
/*@
|
||||
Ox.VideoPreview <f> Video Preview
|
||||
([options[, self]]) -> <o:Ox.Element> Video Preview
|
||||
click <!> click
|
||||
options <o> Options
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.Element> Video Preview
|
||||
click <!> click
|
||||
@*/
|
||||
Ox.VideoPreview = function(options, self) {
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
/*@
|
||||
Ox.VideoTimelinePanel <f> Video timeline panel
|
||||
options <o> Options
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.SplitPanel> Video timeline panel
|
||||
annoationssize <!> annoationssize
|
||||
annotationsfont <!> annotationsfont
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
/*@
|
||||
Ox.VideoTimelinePlayer <f> Video Timeline Player
|
||||
options <o> Options
|
||||
self <o> Shared private variable
|
||||
([options[, self]]) -> <o:Ox.SplitPanel> Video Timeline Player
|
||||
censored <!> censored
|
||||
follow <!> follow
|
||||
|
|
@ -10,8 +12,6 @@ Ox.VideoTimelinePlayer <f> Video Timeline Player
|
|||
position <!> position
|
||||
timeline <!> timeline
|
||||
volume <!> volume
|
||||
options <o> Options
|
||||
self <o> Shared private variable
|
||||
@*/
|
||||
Ox.VideoTimelinePlayer = function(options, self) {
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue