Droppable

指定した要素をドロップを受け入れる要素にします。

マウスによってドラッグ操作が出来る要素を生成します。 ドラッグだけでなく、ドラッグ&ドロップが必要な場合は jQuery UI Draggable も参照してください。

オプション 説明
accept

型:Selector or Function() 初期値:"*"

Selector
受け入れる要素をセレクターで指定します。
Function
ページ内の各ドラッグ要素から、ここで指定した関数が呼ばれます。 関数の第1引数として(おそらくドラッグ要素が)渡されます。 ドロップを受け入れる要素であれば、trueを返すようにしてください。

ドラッグ要素でドロップを受けれる要素の制御を行います。

$( ".selector" ).droppable({ accept: ".special" });
// getter
var accept = $( ".selector" ).droppable( "option", "accept" );

// setter
$( ".selector" ).droppable( "option", "accept", ".special" );
activeClass

型:String
初期値:false

指定した場合は、受け入れドラッグ要素がドラッグされている間は、指定したclassがドロップ要素に追加されます。

addClasses

型:Boolean 初期値:true

falseが設定されると、ui-droppableクラスが追加されません。 数百もの要素でドロップ要素を生成するような、パフォーマンスを最適化する必要がある際に必要とされます。

disabled

型:Boolean 初期値:false

trueを指定すると、ドロップ要素を無効化します。

greedy

型:Boolean 初期値:false

初期状態では、ドロップを受け入れる要素が入れ子になっている場合、 各要素はそれぞれ要素を受け入れますが、 この要素をtrueにすると、親要素はドロップを受け入れなくなります。

hoverClass

型:String 初期値:false

指定されると、ドラッグ要素がドロップを受け入れる要素の上に重なると、指定されたclassを追加します。

scope

型:String 初期値:"default"

acceptオプションに加えて、ドラッグ要素・ドロップ受け入れ要素をセットのグループにします。 ドロップ受け入れ要素と同じscopeの値を持つドラッグ要素がドロップ要素に受け入れられるようになります。

tolerance

型:String 初期値:"intersect"

ドラッグ要素がドロップ受け入れ要素に重なっているかを検証するモードを指定します。

"fit"
完全に重なっているか。
"intersect"
縦横が少なくとも半分は重なっているか。
"pointer"
マウスポインターが重なっているか。
"touch"
重なっている領域があるか。
メソッド説明
destroy()

ドロップの機能を完全に削除します。

$( ".selector" ).droppable( "destroy" );
disable()

ドラッグを無効化します。

enable()

ドラッグを有効にします。

option( optionName )

戻り値:Object

optionNameに指定したオプションの現在の値を取得します。

optionName
型:String
取得したいオプションの名前を指定します。
option()

戻り値:PlainObject

オプションの各キーと値がペアとなったオブジェクトを返します。

option( optionName, value )

引数のoptionNameのオプションに値を設定します。

optionName
型:String
設定したいオプションの名前を指定します。
value
型:Object
設定したい値を指定します。
option( options )

オプションに設定したい各キーと値がペアとなったオブジェクトを指定します。

option
型:Object
設定したいオプションのキーと名前のペアを指定します。
widget()

戻り値:Object

ドラッグを含めたjQueryオブジェクトを返します。

イベント 説明
activate( event, ui )

型:dropactivate

ui.draggable
型:jQuery
ドラッグ要素のjQueryオブジェクトです。
ui.helper
型:jQuery
ドラッグのヘルパー要素のjQueryオブジェクトです。
ui.position
型:Object
ドラッグのヘルパー要素のpositionを{top, left}のオブジェクトとして格納しています。
ui.offset
型:Object
ドラッグのヘルパー要素のoffsetを{top, left}のオブジェクトとして格納しています。

ドロップ受け入れ要素に、ドラッグ要素のがドラッグが開始される際にトリガされます。 ドロップされた際に要素を"ライトアップ"するような場合に有用です。

$( ".selector" ).droppable({
    activate: function( event, ui ) {}
});
$( ".selector" ).on( "dropactivate", function( event, ui ) {} );
create( event, ui )

型:dropcreate

ドロップ受け入れ要素が生成された際にトリガされます。

deactivate( event, ui )

型:dropdeactivate

ui.draggable
型:jQuery
ドラッグ要素のjQueryオブジェクトです。
ui.helper
型:jQuery
ドラッグのヘルパー要素のjQueryオブジェクトです。
ui.position
型:Object
ドラッグのヘルパー要素のpositionを{top, left}のオブジェクトとして格納しています。
ui.offset
型:Object
ドラッグのヘルパー要素のoffsetを{top, left}のオブジェクトとして格納しています。

受け入れドラッグ要素の、ドラッグ操作が停止した際にトリガされます。

drop( event, ui )

型:drop

ui.draggable
型:jQuery
ドラッグ要素のjQueryオブジェクトです。
ui.helper
型:jQuery
ドラッグのヘルパー要素のjQueryオブジェクトです。
ui.position
型:Object
ドラッグのヘルパー要素のpositionを{top, left}のオブジェクトとして格納しています。
ui.offset
型:Object
ドラッグのヘルパー要素のoffsetを{top, left}のオブジェクトとして格納しています。

ドラッグ要素がドロップ受け入れ要素にドラッグされた際にトリガされます。 (ドラッグ条件はthetoleranceオプションに依存します。)

out( event, ui )

型:dropout

ドラッグ要素がドロップ受け入れ要素の外にドラッグされた際にトリガされます。 (ドラッグ条件はthetoleranceオプションに依存します。)

over( event, ui )

型:dropover

ui.draggable
型:jQuery
ドラッグ要素のjQueryオブジェクトです。
ui.helper
型:jQuery
ドラッグのヘルパー要素のjQueryオブジェクトです。
ui.position
型:Object
ドラッグのヘルパー要素のpositionを{top, left}のオブジェクトとして格納しています。
ui.offset
型:Object
ドラッグのヘルパー要素のoffsetを{top, left}のオブジェクトとして格納しています。

ドラッグ要素がドロップ受け入れ要素上に重なった際にトリガされます。 (重なっているかの判定はthetoleranceオプションに依存します。)

 Back to top

© 2010 - 2017 STUDIO KINGDOM