diff --git a/docs/404.html b/docs/404.html index d9467ff9..587594ec 100644 --- a/docs/404.html +++ b/docs/404.html @@ -12,7 +12,7 @@
Skip to content

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.
- + diff --git a/docs/hashmap.json b/docs/hashmap.json index eeeaf10b..fd47eddd 100644 --- a/docs/hashmap.json +++ b/docs/hashmap.json @@ -1 +1 @@ -{"index.md":"eb381693","karte-action-sdk.actionchangestatehook.md":"fef7b1db","karte-action-sdk.actionclosehook.md":"10e81fe6","karte-action-sdk.actionhook.md":"f80564be","karte-action-sdk.actionoptions.context.md":"2fb6dfb3","karte-action-sdk.actionoptions.kartetemplate.md":"d78e11a4","karte-action-sdk.actionoptions.localvariablesquery.md":"e041087f","karte-action-sdk.actionoptions.md":"09d89817","karte-action-sdk.actionoptions.oncreate.md":"950e7a65","karte-action-sdk.actionoptions.props.md":"213359f6","karte-action-sdk.actionoptions.publish.md":"7415c099","karte-action-sdk.actionoptions.send.md":"fdeb5343","karte-action-sdk.actionoptions.variables.md":"d54155f7","karte-action-sdk.actionprops.data.md":"974a251b","karte-action-sdk.actionprops.md":"316df5eb","karte-action-sdk.actionprops.onchangestate.md":"e07b1026","karte-action-sdk.actionprops.onshow.md":"d7fea6d1","karte-action-sdk.actionprops.publish.md":"f8cfe162","karte-action-sdk.actionprops.send.md":"7a33c312","karte-action-sdk.actionvariables.md":"5d46c092","karte-action-sdk.afterupdate.md":"608e2331","karte-action-sdk.applycss.md":"4c853b77","karte-action-sdk.applyglobalcss.md":"8a8ec09e","karte-action-sdk.beforeupdate.md":"647779b1","karte-action-sdk.closeaction.md":"da42c514","karte-action-sdk.closetrigger.md":"1886dbc5","karte-action-sdk.collection.md":"e2aeeaef","karte-action-sdk.create.md":"5bbdddd0","karte-action-sdk.destroyaction.md":"05afa1cf","karte-action-sdk.font.md":"b6169e87","karte-action-sdk.getactionroot.md":"cacd94c0","karte-action-sdk.getcssvariables.md":"7c97d6f2","karte-action-sdk.geteventhandlers.md":"bbb48e62","karte-action-sdk.getstate.md":"a80b120b","karte-action-sdk.getstates.md":"8e8761fe","karte-action-sdk.getsystem.md":"90e55b54","karte-action-sdk.isopened.md":"48c5ee38","karte-action-sdk.widget.md":"ea335006","karte-action-sdk.widget.method.md":"6696cb9d","karte-action-sdk.widget.modalprops.md":"628df86a","karte-action-sdk.widget.onclose.md":"3c0271f7","karte-action-sdk.widget.onshow.md":"ab81b900","karte-action-sdk.widget.publishfunction.md":"87268e55","karte-action-sdk.widget.sendfunction.md":"f974b6c8","karte-action-sdk.widget.setlocalstore.md":"45a16871","karte-action-sdk.widget.setmemorystore.md":"134f5786","karte-action-sdk.widget.setstate.md":"5973c4ca","karte-action-sdk.widget.setval.md":"a9b6a73d","karte-action-sdk.widget.showaction.md":"c9a927fd","karte-action-sdk.widget.storage.md":"6bfbb05f","karte-action-sdk.widget.systemconfig.md":"bdcebeb2","karte-action-sdk.widget.widgeteventname.md":"7de0e131","karte-action-sdk.actioneventhandler.md":"934aebfb","karte-action-sdk.onscrollfunction.md":"ec820369","karte-action-sdk.collectionconfig.md":"e8ad3c91","karte-action-sdk.widget.changevalcallback.md":"5e863313","karte-action-sdk.widget.closeaction.md":"708fef59","karte-action-sdk.widget.on.md":"2625c53b","karte-action-sdk.widget.onchangestate.md":"b17e0cac","karte-action-sdk.widget.onchangeval.md":"b53fbbdf","karte-action-sdk.onchangestate.md":"c4430381","karte-action-sdk.widget.loadstyle.md":"062d50f2","karte-action-sdk.layout_component_names.md":"53bf652a","karte-action-sdk.loadglobalscript.md":"83d1735c","karte-action-sdk.loadglobalstyle.md":"7adfb523","karte-action-sdk.loadstyle.md":"e8a04cb9","karte-action-sdk.md":"73143315","karte-action-sdk.onclose.md":"d0fdead6","karte-action-sdk.widget.actionoptions.send.md":"ee2c3546","karte-action-sdk.widget.actionoptions.variables.md":"d4456aa4","karte-action-sdk.widget.actionprops.data.md":"c7d2246d","karte-action-sdk.widget.actionprops.md":"3f8e3008","karte-action-sdk.widget.actionprops.onchangestate.md":"950b025f","karte-action-sdk.widget.actionprops.onshow.md":"db50b66a","karte-action-sdk.widget.actionprops.publish.md":"776aa9e0","karte-action-sdk.widget.actionprops.send.md":"5b78593f","karte-action-sdk.widget.actionrunnercontext.md":"07675e8c","karte-action-sdk.widget.actionsetting.md":"ca9157e2","karte-action-sdk.widget.actiontablequeryparam.md":"0b1edc0a","karte-action-sdk.widget.actiontablequeryparams.md":"0479b8a0","karte-action-sdk.widget.actiontableresult.md":"25c39e5b","karte-action-sdk.widget.actionvariables.md":"08e1592b","karte-action-sdk.widget.actionoptions.publish.md":"a9e44653","karte-action-sdk.widget.applycss.md":"f45a7b0c","karte-action-sdk.ondestroy.md":"60036c08","karte-action-sdk.widget.closetrigger.md":"0ba66653","karte-action-sdk.onmount.md":"b738ac67","karte-action-sdk.widget.collection.md":"1ea203e0","karte-action-sdk.onscroll.md":"542723e2","karte-action-sdk.onscrollcontext.deltarate.md":"1690ac5c","karte-action-sdk.widget.collectionconfig.md":"7899bd2a","karte-action-sdk.widget.eventcallback.md":"133df561","karte-action-sdk.widget.getactionroot.md":"a170fd00","karte-action-sdk.widget.getcssvariables.md":"bf9501f2","karte-action-sdk.widget.getlocalstore.md":"36be82ed","karte-action-sdk.widget.getmemorystore.md":"11ff7f53","karte-action-sdk.widget.getstate.md":"4c44ed28","karte-action-sdk.widget.getval.md":"0fb96ae9","karte-action-sdk.widget.collection_0.md":"da3aec1a","karte-action-sdk.onscrollcontext.direction.md":"9a3154ba","karte-action-sdk.onscrollcontext.md":"6afcf584","karte-action-sdk.onscrollcontext.previousrate.md":"df510c7a","karte-action-sdk.onscrollcontext.rate.md":"9caf7d74","karte-action-sdk.onscrollcontext.scrollrate.md":"1d263c4b","karte-action-sdk.onshow.md":"4f020fe3","karte-action-sdk.ontime.md":"19e987ac","karte-action-sdk.publishfunction.md":"5eb46931","karte-action-sdk.reseteventhandlers.md":"12f082fb","karte-action-sdk.resetvariables.md":"044b2b22","karte-action-sdk.scrolldirection.md":"250fd662","karte-action-sdk.sendfunction.md":"888f19e0","karte-action-sdk.seteventhandlers.md":"1ededee9","karte-action-sdk.setsetting.md":"a413a335","karte-action-sdk.setstate.md":"5cd76f0b","karte-action-sdk.showaction.md":"03f03091","karte-action-sdk.systemconfig.md":"feae5260","karte-action-sdk.tick.md":"78264b72","karte-action-sdk.widget.actionchangestatehook.md":"9fe66f39","karte-action-sdk.widget.actionclosehook.md":"5f221982","karte-action-sdk.widget.actioneventhandler.md":"639f2fb6","karte-action-sdk.widget.actionhook.md":"25861dd6","karte-action-sdk.oncreate.md":"b293641c","karte-action-sdk.ondestory.md":"f8027936","karte-action-sdk.widget.actionoptions.context.md":"0adaed72","karte-action-sdk.widget.actionoptions.kartetemplate.md":"97046dc8","karte-action-sdk.widget.actionoptions.localvariablesquery.md":"d028133c","karte-action-sdk.widget.actionoptions.md":"ff34070e","karte-action-sdk.widget.actionoptions.oncreate.md":"053069b6","karte-action-sdk.widget.actionoptions.props.md":"8f94a6e8"} +{"karte-action-sdk.getsystem.md":"90e55b54","karte-action-sdk.isopened.md":"48c5ee38","karte-action-sdk.layout_component_names.md":"53bf652a","karte-action-sdk.loadglobalscript.md":"83d1735c","karte-action-sdk.loadglobalstyle.md":"7adfb523","karte-action-sdk.loadstyle.md":"e8a04cb9","karte-action-sdk.onclose.md":"d0fdead6","karte-action-sdk.oncreate.md":"b293641c","karte-action-sdk.ondestory.md":"f8027936","karte-action-sdk.ondestroy.md":"60036c08","karte-action-sdk.getstates.md":"8e8761fe","karte-action-sdk.onchangestate.md":"c4430381","karte-action-sdk.onmount.md":"b738ac67","karte-action-sdk.onscroll.md":"542723e2","karte-action-sdk.onscrollcontext.deltarate.md":"1690ac5c","karte-action-sdk.md":"73143315","karte-action-sdk.scrolldirection.md":"250fd662","karte-action-sdk.seteventhandlers.md":"1ededee9","karte-action-sdk.onscrollcontext.direction.md":"9a3154ba","karte-action-sdk.widget.actionoptions.publish.md":"a9e44653","karte-action-sdk.sendfunction.md":"888f19e0","karte-action-sdk.actionchangestatehook.md":"fef7b1db","index.md":"eb381693","karte-action-sdk.actionclosehook.md":"10e81fe6","karte-action-sdk.actioneventhandler.md":"934aebfb","karte-action-sdk.getstate.md":"a80b120b","karte-action-sdk.actionoptions.publish.md":"7415c099","karte-action-sdk.actionoptions.context.md":"2fb6dfb3","karte-action-sdk.actionoptions.kartetemplate.md":"d78e11a4","karte-action-sdk.actionoptions.localvariablesquery.md":"e041087f","karte-action-sdk.actionoptions.md":"09d89817","karte-action-sdk.actionoptions.oncreate.md":"950e7a65","karte-action-sdk.actionoptions.props.md":"213359f6","karte-action-sdk.destroyaction.md":"05afa1cf","karte-action-sdk.actionoptions.send.md":"fdeb5343","karte-action-sdk.actionoptions.variables.md":"d54155f7","karte-action-sdk.actionprops.data.md":"974a251b","karte-action-sdk.actionprops.md":"316df5eb","karte-action-sdk.actionprops.onchangestate.md":"e07b1026","karte-action-sdk.actionprops.onshow.md":"d7fea6d1","karte-action-sdk.actionprops.publish.md":"f8cfe162","karte-action-sdk.actionprops.send.md":"7a33c312","karte-action-sdk.actionvariables.md":"5d46c092","karte-action-sdk.afterupdate.md":"608e2331","karte-action-sdk.applycss.md":"4c853b77","karte-action-sdk.applyglobalcss.md":"8a8ec09e","karte-action-sdk.beforeupdate.md":"647779b1","karte-action-sdk.closeaction.md":"da42c514","karte-action-sdk.closetrigger.md":"1886dbc5","karte-action-sdk.collection.md":"e2aeeaef","karte-action-sdk.collectionconfig.md":"e8ad3c91","karte-action-sdk.create.md":"5bbdddd0","karte-action-sdk.onscrollcontext.scrollrate.md":"1d263c4b","karte-action-sdk.font.md":"b6169e87","karte-action-sdk.getactionroot.md":"cacd94c0","karte-action-sdk.widget.actionprops.onshow.md":"db50b66a","karte-action-sdk.widget.applycss.md":"f45a7b0c","karte-action-sdk.widget.getmemorystore.md":"11ff7f53","karte-action-sdk.widget.getstate.md":"4c44ed28","karte-action-sdk.widget.getval.md":"0fb96ae9","karte-action-sdk.widget.loadstyle.md":"062d50f2","karte-action-sdk.widget.md":"ea335006","karte-action-sdk.widget.method.md":"6696cb9d","karte-action-sdk.widget.modalprops.md":"628df86a","karte-action-sdk.widget.on.md":"2625c53b","karte-action-sdk.widget.onchangestate.md":"b17e0cac","karte-action-sdk.widget.onchangeval.md":"b53fbbdf","karte-action-sdk.widget.onclose.md":"3c0271f7","karte-action-sdk.widget.onshow.md":"ab81b900","karte-action-sdk.widget.publishfunction.md":"87268e55","karte-action-sdk.widget.sendfunction.md":"f974b6c8","karte-action-sdk.widget.setlocalstore.md":"45a16871","karte-action-sdk.widget.setmemorystore.md":"134f5786","karte-action-sdk.widget.setstate.md":"5973c4ca","karte-action-sdk.widget.setval.md":"a9b6a73d","karte-action-sdk.widget.showaction.md":"c9a927fd","karte-action-sdk.getcssvariables.md":"7c97d6f2","karte-action-sdk.geteventhandlers.md":"bbb48e62","karte-action-sdk.onscrollcontext.md":"6afcf584","karte-action-sdk.onscrollcontext.previousrate.md":"df510c7a","karte-action-sdk.onscrollcontext.rate.md":"9caf7d74","karte-action-sdk.reseteventhandlers.md":"12f082fb","karte-action-sdk.onscrollfunction.md":"ec820369","karte-action-sdk.widget.storage.md":"6bfbb05f","karte-action-sdk.widget.systemconfig.md":"bdcebeb2","karte-action-sdk.widget.widgeteventname.md":"7de0e131","karte-action-sdk.actionhook.md":"f80564be","karte-action-sdk.widget.getlocalstore.md":"36be82ed","karte-action-sdk.onshow.md":"4f020fe3","karte-action-sdk.ontime.md":"19e987ac","karte-action-sdk.publishfunction.md":"5eb46931","karte-action-sdk.setstate.md":"5cd76f0b","karte-action-sdk.resetvariables.md":"044b2b22","karte-action-sdk.showaction.md":"03f03091","karte-action-sdk.setsetting.md":"a413a335","karte-action-sdk.widget.actionchangestatehook.md":"9fe66f39","karte-action-sdk.widget.actionclosehook.md":"5f221982","karte-action-sdk.widget.actioneventhandler.md":"639f2fb6","karte-action-sdk.widget.actionhook.md":"25861dd6","karte-action-sdk.widget.actionoptions.context.md":"0adaed72","karte-action-sdk.widget.actionoptions.kartetemplate.md":"97046dc8","karte-action-sdk.widget.actionoptions.localvariablesquery.md":"d028133c","karte-action-sdk.widget.actionoptions.md":"ff34070e","karte-action-sdk.widget.actionoptions.oncreate.md":"053069b6","karte-action-sdk.widget.actionoptions.props.md":"8f94a6e8","karte-action-sdk.widget.actionoptions.send.md":"ee2c3546","karte-action-sdk.widget.actionoptions.variables.md":"d4456aa4","karte-action-sdk.widget.actionprops.data.md":"c7d2246d","karte-action-sdk.widget.actionprops.md":"3f8e3008","karte-action-sdk.widget.actionrunnercontext.md":"07675e8c","karte-action-sdk.widget.getcssvariables.md":"bf9501f2","karte-action-sdk.widget.actionsetting.md":"ca9157e2","karte-action-sdk.widget.actiontablequeryparam.md":"0b1edc0a","karte-action-sdk.widget.actiontablequeryparams.md":"0479b8a0","karte-action-sdk.widget.actiontableresult.md":"25c39e5b","karte-action-sdk.widget.closeaction.md":"708fef59","karte-action-sdk.widget.closetrigger.md":"0ba66653","karte-action-sdk.widget.collection.md":"1ea203e0","karte-action-sdk.widget.collection_0.md":"da3aec1a","karte-action-sdk.widget.collectionconfig.md":"7899bd2a","karte-action-sdk.widget.getactionroot.md":"a170fd00","karte-action-sdk.systemconfig.md":"feae5260","karte-action-sdk.tick.md":"78264b72","karte-action-sdk.widget.actionprops.onchangestate.md":"950b025f","karte-action-sdk.widget.actionprops.publish.md":"776aa9e0","karte-action-sdk.widget.actionprops.send.md":"5b78593f","karte-action-sdk.widget.changevalcallback.md":"5e863313","karte-action-sdk.widget.eventcallback.md":"133df561","karte-action-sdk.widget.actionvariables.md":"08e1592b"} diff --git a/docs/index.html b/docs/index.html index 67702093..64d43cff 100644 --- a/docs/index.html +++ b/docs/index.html @@ -13,7 +13,7 @@
Skip to content
On this page

Home

API Reference

Packages

PackageDescription
@plaidev/karte-action-sdk
- + diff --git a/docs/karte-action-sdk.actionchangestatehook.html b/docs/karte-action-sdk.actionchangestatehook.html index 267660a6..f1fc3e9f 100644 --- a/docs/karte-action-sdk.actionchangestatehook.html +++ b/docs/karte-action-sdk.actionchangestatehook.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionChangeStateHook

ActionChangeStateHook type

アクションのライフサイクル changeState で呼び出されるフック関数

Signature:

typescript
type ActionChangeStateHook<Props, Variables> = (props: Parameters<ActionHook<Props, Variables & ActionVariables>>[0], newState: string) => void | Promise<void>;
 

References: ActionHook, ActionVariables

- + diff --git a/docs/karte-action-sdk.actionclosehook.html b/docs/karte-action-sdk.actionclosehook.html index efd21052..f4a494c1 100644 --- a/docs/karte-action-sdk.actionclosehook.html +++ b/docs/karte-action-sdk.actionclosehook.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionCloseHook

ActionCloseHook type

アクションのライフサイクル close で呼び出されるフックする関数

Signature:

typescript
type ActionCloseHook<Props extends ModalProps$1, Variables> = (props: Parameters<ActionHook<Props, Variables & ActionVariables>>[0], trigger: CloseTrigger) => void | Promise<void>;
 

References: ActionHook, ActionVariables, CloseTrigger

- + diff --git a/docs/karte-action-sdk.actioneventhandler.html b/docs/karte-action-sdk.actioneventhandler.html index ffd47c02..de222c70 100644 --- a/docs/karte-action-sdk.actioneventhandler.html +++ b/docs/karte-action-sdk.actioneventhandler.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionEventHandler

ActionEventHandler type

アクションのイベントハンドラ

Signature:

typescript
type ActionEventHandler = (...args: any[]) => any | Promise<any>;
 
- + diff --git a/docs/karte-action-sdk.actionhook.html b/docs/karte-action-sdk.actionhook.html index d64a15e0..4f5d2b83 100644 --- a/docs/karte-action-sdk.actionhook.html +++ b/docs/karte-action-sdk.actionhook.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionHook

ActionHook type

アクションのライフサイクルで呼び出されるフック

Signature:

typescript
type ActionHook<Props, Variables> = (props: ActionProps<Props, Variables & ActionVariables>) => void | Promise<void>;
 

References: ActionProps, ActionVariables

- + diff --git a/docs/karte-action-sdk.actionoptions.context.html b/docs/karte-action-sdk.actionoptions.context.html index ed6a2464..c480e20d 100644 --- a/docs/karte-action-sdk.actionoptions.context.html +++ b/docs/karte-action-sdk.actionoptions.context.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionOptions > context

ActionOptions.context property

アクション実行時のコンテキスト

Signature:

typescript
context: ActionRunnerContext;
 
- + diff --git a/docs/karte-action-sdk.actionoptions.html b/docs/karte-action-sdk.actionoptions.html index ac37dd83..3fabd671 100644 --- a/docs/karte-action-sdk.actionoptions.html +++ b/docs/karte-action-sdk.actionoptions.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionOptions

ActionOptions interface

create() 向けのオプション

Signature:

typescript
interface ActionOptions<Props, Variables, VariablesQuery> 
 

Properties

PropertyModifiersTypeDescription
contextActionRunnerContextアクション実行時のコンテキスト
karteTemplate?{ [key: string]: any; }(Optional) KARTEテンプレートの情報
localVariablesQuery?VariablesQuery(Optional) アクションで使用されるアクション実行時に取得される変数
onCreate?ActionHook<Props, Variables & ActionVariables>(Optional) アクションが作成されているときにフックされる onCreate()
props?Props(Optional) アクションで使用されるプロパティ
publish?PublishFunction(Optional) アクション内でタグのQueueにリクエストを発行する関数
send?SendFunction(Optional) アクション内でイベントを発火する関数
variables?Variables(Optional) アクションで使用される解析時に取得される変数
- + diff --git a/docs/karte-action-sdk.actionoptions.kartetemplate.html b/docs/karte-action-sdk.actionoptions.kartetemplate.html index e91b82dd..33eb00b2 100644 --- a/docs/karte-action-sdk.actionoptions.kartetemplate.html +++ b/docs/karte-action-sdk.actionoptions.kartetemplate.html @@ -16,7 +16,7 @@ [key: string]: any; }; - + diff --git a/docs/karte-action-sdk.actionoptions.localvariablesquery.html b/docs/karte-action-sdk.actionoptions.localvariablesquery.html index 22eb803e..58f92e77 100644 --- a/docs/karte-action-sdk.actionoptions.localvariablesquery.html +++ b/docs/karte-action-sdk.actionoptions.localvariablesquery.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionOptions > localVariablesQuery

ActionOptions.localVariablesQuery property

アクションで使用されるアクション実行時に取得される変数

Signature:

typescript
localVariablesQuery?: VariablesQuery;
 
- + diff --git a/docs/karte-action-sdk.actionoptions.oncreate.html b/docs/karte-action-sdk.actionoptions.oncreate.html index df3cb888..7039ce4f 100644 --- a/docs/karte-action-sdk.actionoptions.oncreate.html +++ b/docs/karte-action-sdk.actionoptions.oncreate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionOptions > onCreate

ActionOptions.onCreate property

アクションが作成されているときにフックされる onCreate()

Signature:

typescript
onCreate?: ActionHook<Props, Variables & ActionVariables>;
 
- + diff --git a/docs/karte-action-sdk.actionoptions.props.html b/docs/karte-action-sdk.actionoptions.props.html index 22e7cb7d..d8e2bea7 100644 --- a/docs/karte-action-sdk.actionoptions.props.html +++ b/docs/karte-action-sdk.actionoptions.props.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionOptions > props

ActionOptions.props property

アクションで使用されるプロパティ

Signature:

typescript
props?: Props;
 
- + diff --git a/docs/karte-action-sdk.actionoptions.publish.html b/docs/karte-action-sdk.actionoptions.publish.html index 975f38ea..81bc4e29 100644 --- a/docs/karte-action-sdk.actionoptions.publish.html +++ b/docs/karte-action-sdk.actionoptions.publish.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionOptions > publish

ActionOptions.publish property

アクション内でタグのQueueにリクエストを発行する関数

Signature:

typescript
publish?: PublishFunction;
 
- + diff --git a/docs/karte-action-sdk.actionoptions.send.html b/docs/karte-action-sdk.actionoptions.send.html index d93782b4..5a9fd3cb 100644 --- a/docs/karte-action-sdk.actionoptions.send.html +++ b/docs/karte-action-sdk.actionoptions.send.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionOptions > send

ActionOptions.send property

アクション内でイベントを発火する関数

Signature:

typescript
send?: SendFunction;
 
- + diff --git a/docs/karte-action-sdk.actionoptions.variables.html b/docs/karte-action-sdk.actionoptions.variables.html index d0f51409..efa45f5a 100644 --- a/docs/karte-action-sdk.actionoptions.variables.html +++ b/docs/karte-action-sdk.actionoptions.variables.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionOptions > variables

ActionOptions.variables property

アクションで使用される解析時に取得される変数

Signature:

typescript
variables?: Variables;
 
- + diff --git a/docs/karte-action-sdk.actionprops.data.html b/docs/karte-action-sdk.actionprops.data.html index 7a02c948..a5ba1d98 100644 --- a/docs/karte-action-sdk.actionprops.data.html +++ b/docs/karte-action-sdk.actionprops.data.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionProps > data

ActionProps.data property

アクションで使用されるデータ

Signature:

typescript
data: Props & Variables & ActionVariables;
 
- + diff --git a/docs/karte-action-sdk.actionprops.html b/docs/karte-action-sdk.actionprops.html index 127cd433..8951cb96 100644 --- a/docs/karte-action-sdk.actionprops.html +++ b/docs/karte-action-sdk.actionprops.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionProps

ActionProps interface

アクションのプロパティ

Signature:

typescript
interface ActionProps<Props, Variables> 
 

Properties

PropertyModifiersTypeDescription
dataProps & Variables & ActionVariablesアクションで使用されるデータ
onChangeState?ActionChangeStateHook<Props, Variables & ActionVariables>(Optional) アクションのステートが変更されたときにフックされる onChangeState()
onShow?ActionHook<Props, Variables & ActionVariables>(Optional) アクションが表示されたときにフックされる onShow()
publishPublishFunctionアクション内でタグのQueueにリクエストを発行する関数
sendSendFunctionアクションでイベントがトリガーされたときに受信するための関数
- + diff --git a/docs/karte-action-sdk.actionprops.onchangestate.html b/docs/karte-action-sdk.actionprops.onchangestate.html index fb3aa1c0..407fa2cb 100644 --- a/docs/karte-action-sdk.actionprops.onchangestate.html +++ b/docs/karte-action-sdk.actionprops.onchangestate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionProps > onChangeState

ActionProps.onChangeState property

アクションのステートが変更されたときにフックされる onChangeState()

Signature:

typescript
onChangeState?: ActionChangeStateHook<Props, Variables & ActionVariables>;
 
- + diff --git a/docs/karte-action-sdk.actionprops.onshow.html b/docs/karte-action-sdk.actionprops.onshow.html index 43b098e6..8741aa97 100644 --- a/docs/karte-action-sdk.actionprops.onshow.html +++ b/docs/karte-action-sdk.actionprops.onshow.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionProps > onShow

ActionProps.onShow property

アクションが表示されたときにフックされる onShow()

Signature:

typescript
onShow?: ActionHook<Props, Variables & ActionVariables>;
 
- + diff --git a/docs/karte-action-sdk.actionprops.publish.html b/docs/karte-action-sdk.actionprops.publish.html index 7e28b35a..17627864 100644 --- a/docs/karte-action-sdk.actionprops.publish.html +++ b/docs/karte-action-sdk.actionprops.publish.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionProps > publish

ActionProps.publish property

アクション内でタグのQueueにリクエストを発行する関数

Signature:

typescript
publish: PublishFunction;
 
- + diff --git a/docs/karte-action-sdk.actionprops.send.html b/docs/karte-action-sdk.actionprops.send.html index 02c67c58..657500f0 100644 --- a/docs/karte-action-sdk.actionprops.send.html +++ b/docs/karte-action-sdk.actionprops.send.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ActionProps > send

ActionProps.send property

アクションでイベントがトリガーされたときに受信するための関数

Signature:

typescript
send: SendFunction;
 
- + diff --git a/docs/karte-action-sdk.actionvariables.html b/docs/karte-action-sdk.actionvariables.html index c7ea45c5..74d7eff1 100644 --- a/docs/karte-action-sdk.actionvariables.html +++ b/docs/karte-action-sdk.actionvariables.html @@ -16,7 +16,7 @@ [key: string]: any; }; - + diff --git a/docs/karte-action-sdk.afterupdate.html b/docs/karte-action-sdk.afterupdate.html index b711de69..43ba753d 100644 --- a/docs/karte-action-sdk.afterupdate.html +++ b/docs/karte-action-sdk.afterupdate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > afterUpdate

afterUpdate variable

エレメントを更新した後に実行される関数の登録

Signature:

typescript
afterUpdate: typeof afterUpdateSvelte
 
- + diff --git a/docs/karte-action-sdk.applycss.html b/docs/karte-action-sdk.applycss.html index ae17591f..ac4bb0d6 100644 --- a/docs/karte-action-sdk.applycss.html +++ b/docs/karte-action-sdk.applycss.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > applyCss

applyCss() function

アクションに CSS を適用する

Signature:

typescript
declare function applyCss(css: string): Promise<HTMLStyleElement>;
 

Parameters

ParameterTypeDescription
cssstring適用する CSS

Returns:

Promise<HTMLStyleElement>

適用された style 要素を返す Promise

- + diff --git a/docs/karte-action-sdk.applyglobalcss.html b/docs/karte-action-sdk.applyglobalcss.html index 88b43a4f..23a529e1 100644 --- a/docs/karte-action-sdk.applyglobalcss.html +++ b/docs/karte-action-sdk.applyglobalcss.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > applyGlobalCss

applyGlobalCss() function

グローバル CSS をページに適用する

Signature:

typescript
declare function applyGlobalCss(css: string): Promise<any>;
 

Parameters

ParameterTypeDescription
cssstringCSS

Returns:

Promise<any>

- + diff --git a/docs/karte-action-sdk.beforeupdate.html b/docs/karte-action-sdk.beforeupdate.html index 14f9ca36..c6835fd0 100644 --- a/docs/karte-action-sdk.beforeupdate.html +++ b/docs/karte-action-sdk.beforeupdate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > beforeUpdate

beforeUpdate variable

エレメントを更新する前に実行される関数の登録

Signature:

typescript
beforeUpdate: typeof beforeUpdateSvelte
 
- + diff --git a/docs/karte-action-sdk.closeaction.html b/docs/karte-action-sdk.closeaction.html index 3d114470..6805f575 100644 --- a/docs/karte-action-sdk.closeaction.html +++ b/docs/karte-action-sdk.closeaction.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > closeAction

closeAction() function

アクションを閉じる

Signature:

typescript
declare function closeAction(trigger?: CloseTrigger): void;
 

Parameters

ParameterTypeDescription
triggerCloseTrigger(Optional) 閉じた時のトリガー。デフォルト 'none'

Returns:

void

- + diff --git a/docs/karte-action-sdk.closetrigger.html b/docs/karte-action-sdk.closetrigger.html index 517eecfe..b86617a2 100644 --- a/docs/karte-action-sdk.closetrigger.html +++ b/docs/karte-action-sdk.closetrigger.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > CloseTrigger

CloseTrigger type

閉じるアクショントリガー

Signature:

typescript
type CloseTrigger = "button" | "overlay" | "auto" | "none";
 
- + diff --git a/docs/karte-action-sdk.collection.html b/docs/karte-action-sdk.collection.html index e0a8e456..7b4aec65 100644 --- a/docs/karte-action-sdk.collection.html +++ b/docs/karte-action-sdk.collection.html @@ -20,7 +20,7 @@ set(key: string, value: string, cb: (err: Error | null) => void): void; };

Parameters

ParameterTypeDescription
configCollectionConfig設定情報

Returns:

{ get(key: string | Array<string>, cb: (err: Error | null, items?: ActionTableResult | Array<ActionTableResult>) => void): void; getByQuery(query_name: string, params: ActionTableQueryParams, options: { ignore_fields?: string[]; } | null | undefined, cb: (err: Error | null, items?: Array<ActionTableResult>) => void): void; set(key: string, value: string, cb: (err: Error | null) => void): void; }

メソッドを返します

- + diff --git a/docs/karte-action-sdk.collectionconfig.html b/docs/karte-action-sdk.collectionconfig.html index 840b9d23..37032b5a 100644 --- a/docs/karte-action-sdk.collectionconfig.html +++ b/docs/karte-action-sdk.collectionconfig.html @@ -18,7 +18,7 @@ endpoint?: string; }; - + diff --git a/docs/karte-action-sdk.create.html b/docs/karte-action-sdk.create.html index 3159233f..a04a1ea7 100644 --- a/docs/karte-action-sdk.create.html +++ b/docs/karte-action-sdk.create.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > create

create() function

アクションを作成する

Signature:

typescript
declare function create<Props extends ModalProps, Variables, VariablesQuery extends Array<VariableQuery>>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & ActionVariables, VariablesQuery>): () => void;
 

Parameters

ParameterTypeDescription
Apptypeof SvelteComponentDevSvelte コンポーネントのエントリポイント
optionsActionOptions<Props, Variables & ActionVariables, VariablesQuery>(Optional) オプション

Returns:

() => void

アクションを破棄する関数

- + diff --git a/docs/karte-action-sdk.destroyaction.html b/docs/karte-action-sdk.destroyaction.html index 71be1fb1..db6a6a61 100644 --- a/docs/karte-action-sdk.destroyaction.html +++ b/docs/karte-action-sdk.destroyaction.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > destroyAction

destroyAction() function

アクションの破棄する

Signature:

typescript
declare function destroyAction(): void;
 

Returns:

void

- + diff --git a/docs/karte-action-sdk.font.html b/docs/karte-action-sdk.font.html index e55c9dec..b67a6a9e 100644 --- a/docs/karte-action-sdk.font.html +++ b/docs/karte-action-sdk.font.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > Font

Font type

Signature:

typescript
type Font = (typeof Fonts)[number];
 
- + diff --git a/docs/karte-action-sdk.getactionroot.html b/docs/karte-action-sdk.getactionroot.html index e8d6a9c2..380373c6 100644 --- a/docs/karte-action-sdk.getactionroot.html +++ b/docs/karte-action-sdk.getactionroot.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > getActionRoot

getActionRoot() function

アクションのルートの DOM 要素を取得する

Signature:

typescript
declare function getActionRoot(): ShadowRoot | null;
 

Returns:

ShadowRoot | null

アクションがルートの DOM 要素 を持つ場合は DOM 要素を返します。ない場合は null を返します

- + diff --git a/docs/karte-action-sdk.getcssvariables.html b/docs/karte-action-sdk.getcssvariables.html index a85c06c2..90f5a173 100644 --- a/docs/karte-action-sdk.getcssvariables.html +++ b/docs/karte-action-sdk.getcssvariables.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > getCssVariables

getCssVariables() function

Signature:

typescript
declare function getCssVariables<Props extends ModalProps$1, Variables>(data: Writable<Props & Variables & ActionVariables & VariableQuery>): string;
 

Parameters

ParameterTypeDescription
dataWritable<Props & Variables & ActionVariables & VariableQuery>

Returns:

string

- + diff --git a/docs/karte-action-sdk.geteventhandlers.html b/docs/karte-action-sdk.geteventhandlers.html index 260799bf..75c79ab6 100644 --- a/docs/karte-action-sdk.geteventhandlers.html +++ b/docs/karte-action-sdk.geteventhandlers.html @@ -16,7 +16,7 @@ [key: string]: ActionEventHandler; };

Returns:

{ [key: string]: ActionEventHandler; }

現在のイベントハンドラー

- + diff --git a/docs/karte-action-sdk.getstate.html b/docs/karte-action-sdk.getstate.html index f649ee30..d581f180 100644 --- a/docs/karte-action-sdk.getstate.html +++ b/docs/karte-action-sdk.getstate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > getState

getState() function

現在のステートを取得する

Signature:

typescript
declare function getState(): string;
 

Returns:

string

現在のステートID

Remarks

アクションが表示されて設定されるため、onShow() フック関数で利用できます。

- + diff --git a/docs/karte-action-sdk.getstates.html b/docs/karte-action-sdk.getstates.html index f8e4322c..5e389b94 100644 --- a/docs/karte-action-sdk.getstates.html +++ b/docs/karte-action-sdk.getstates.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > getStates

getStates() function

ステートID一覧を取得する

Signature:

typescript
declare function getStates(): string[];
 

Returns:

string[]

すべてのステートID

Remarks

アクションが表示されて設定されるため、onShow() フック関数で利用できます。

- + diff --git a/docs/karte-action-sdk.getsystem.html b/docs/karte-action-sdk.getsystem.html index 78516203..ee543a87 100644 --- a/docs/karte-action-sdk.getsystem.html +++ b/docs/karte-action-sdk.getsystem.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > getSystem

getSystem() function

KARTE の設定を取得する

Signature:

typescript
declare function getSystem(): SystemConfig;
 

Returns:

SystemConfig

現在の KARTE システムの設定を返します

Remarks

アクションが表示されて設定されるため、onShow() フック関数で利用できます。 取得できる設定は、APIキー、接客ID、アクションショートIDなどです。

- + diff --git a/docs/karte-action-sdk.html b/docs/karte-action-sdk.html index 36f8bab1..cd9c904d 100644 --- a/docs/karte-action-sdk.html +++ b/docs/karte-action-sdk.html @@ -13,7 +13,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk

karte-action-sdk package

Functions

FunctionDescription
applyCss(css)アクションに CSS を適用する
applyGlobalCss(css)グローバル CSS をページに適用する
closeAction(trigger)アクションを閉じる
collection(config)アクションテーブルを管理するメソッドを取得する
create(App, options)アクションを作成する
destroyAction()アクションの破棄する
getActionRoot()アクションのルートの DOM 要素を取得する
getCssVariables(data)
getEventHandlers()イベントハンドラーの一覧を取得する
getState()現在のステートを取得する
getStates()ステートID一覧を取得する
getSystem()KARTE の設定を取得する
isOpened()アクションの表示・非表示の状態を取得する
loadGlobalScript(src)ES Modules に対応していない JavaScript をページに読み込む
loadGlobalStyle(href)style ファイルをページに読み込む
loadStyle(href)アクションにグローバルなスタイルを読み込む
onChangeState(fn)アクションのステートが変更された (changeState) 後にフックする関数
onClose(fn)アクションがクローズ (close) される前にフックする関数
onCreate(fn)アクションが作成 (create) される前にフックする関数
onDestroy(fn)アクションが破棄 (destroy) される前にフックする関数
onScroll(rate, fn)スクロール率が達したときに呼び出すコールバックを登録します
onShow(fn)アクションが表示 (show) された後にフックする関数
onTime(time, fn)指定した時間の経過後に呼び出すコールバックを登録します
resetEventHandlers()イベントハンドラーをリセットする
resetVariables()変数をリセットする
setEventHandlers(handlers)イベントハンドラーを登録する
setSetting(setting)アクション設定を更新する
setState(stateId, options)現在のステートを設定する
showAction()アクションを表示する

Interfaces

InterfaceDescription
ActionOptionscreate() 向けのオプション
ActionPropsアクションのプロパティ
OnScrollContextonScroll() のスクロールコンテキスト情報

Namespaces

NamespaceDescription
widget

Variables

VariableDescription
afterUpdateエレメントを更新した後に実行される関数の登録
beforeUpdateエレメントを更新する前に実行される関数の登録
LAYOUT_COMPONENT_NAMES
onDestoryエレメントを破棄したときに実行される関数の登録
onMountエレメントをマウントしたときに実行される関数の登録
tickエレメントのライフサイクルを進める

Type Aliases

Type AliasDescription
ActionChangeStateHookアクションのライフサイクル changeState で呼び出されるフック関数
ActionCloseHookアクションのライフサイクル close で呼び出されるフックする関数
ActionEventHandlerアクションのイベントハンドラ
ActionHookアクションのライフサイクルで呼び出されるフック
ActionVariablesアクションの変数
CloseTrigger閉じるアクショントリガー
CollectionConfigアクションテーブルの設定情報
Font
OnScrollFunctiononScroll() によって呼び出されるコールバック関数
PublishFunctionアクションの publish 関数
ScrollDirectionスクロール方向
SendFunctionアクションの send 関数
SystemConfigKARTE のシステム設定情報
- + diff --git a/docs/karte-action-sdk.isopened.html b/docs/karte-action-sdk.isopened.html index 5eed6519..a963d563 100644 --- a/docs/karte-action-sdk.isopened.html +++ b/docs/karte-action-sdk.isopened.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > isOpened

isOpened() function

アクションの表示・非表示の状態を取得する

Signature:

typescript
declare function isOpened(): boolean;
 

Returns:

boolean

アクションが表示されているときは true、非表示のときは false を返します。

- + diff --git a/docs/karte-action-sdk.layout_component_names.html b/docs/karte-action-sdk.layout_component_names.html index 9399da15..c0727eda 100644 --- a/docs/karte-action-sdk.layout_component_names.html +++ b/docs/karte-action-sdk.layout_component_names.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > LAYOUT_COMPONENT_NAMES

LAYOUT_COMPONENT_NAMES variable

Signature:

typescript
LAYOUT_COMPONENT_NAMES: string[]
 
- + diff --git a/docs/karte-action-sdk.loadglobalscript.html b/docs/karte-action-sdk.loadglobalscript.html index 135432b2..87ffabfc 100644 --- a/docs/karte-action-sdk.loadglobalscript.html +++ b/docs/karte-action-sdk.loadglobalscript.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > loadGlobalScript

loadGlobalScript() function

ES Modules に対応していない JavaScript をページに読み込む

Signature:

typescript
declare function loadGlobalScript(src: string): Promise<any>;
 

Parameters

ParameterTypeDescription
srcstringJavaScript ファイルのリンク URL

Returns:

Promise<any>

- + diff --git a/docs/karte-action-sdk.loadglobalstyle.html b/docs/karte-action-sdk.loadglobalstyle.html index 88cbedb2..411a3670 100644 --- a/docs/karte-action-sdk.loadglobalstyle.html +++ b/docs/karte-action-sdk.loadglobalstyle.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > loadGlobalStyle

loadGlobalStyle() function

style ファイルをページに読み込む

Signature:

typescript
declare function loadGlobalStyle(href: string): Promise<any>;
 

Parameters

ParameterTypeDescription
hrefstringstyle ファイルのリンク URL

Returns:

Promise<any>

- + diff --git a/docs/karte-action-sdk.loadstyle.html b/docs/karte-action-sdk.loadstyle.html index 65349426..c33b85c1 100644 --- a/docs/karte-action-sdk.loadstyle.html +++ b/docs/karte-action-sdk.loadstyle.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > loadStyle

loadStyle() function

アクションにグローバルなスタイルを読み込む

Signature:

typescript
declare function loadStyle(href: string): Promise<void>;
 

Parameters

ParameterTypeDescription
hrefstringstyle ファイルのリンク URL

Returns:

Promise<void>

- + diff --git a/docs/karte-action-sdk.onchangestate.html b/docs/karte-action-sdk.onchangestate.html index 77cd4299..9885dbc8 100644 --- a/docs/karte-action-sdk.onchangestate.html +++ b/docs/karte-action-sdk.onchangestate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > onChangeState

onChangeState() function

アクションのステートが変更された (changeState) 後にフックする関数

Signature:

typescript
declare function onChangeState<Props extends ModalProps$1, Variables>(fn: ActionChangeStateHook<Props, Variables & ActionVariables>): void;
 

Parameters

ParameterTypeDescription
fnActionChangeStateHook<Props, Variables & ActionVariables>呼び出されるフック関数

Returns:

void

- + diff --git a/docs/karte-action-sdk.onclose.html b/docs/karte-action-sdk.onclose.html index a3eae6a0..46fbab9f 100644 --- a/docs/karte-action-sdk.onclose.html +++ b/docs/karte-action-sdk.onclose.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > onClose

onClose() function

アクションがクローズ (close) される前にフックする関数

Signature:

typescript
declare function onClose<Props extends ModalProps$1, Variables>(fn: ActionCloseHook<Props, Variables & ActionVariables>): void;
 

Parameters

ParameterTypeDescription
fnActionCloseHook<Props, Variables & ActionVariables>呼び出されるフック関数

Returns:

void

- + diff --git a/docs/karte-action-sdk.oncreate.html b/docs/karte-action-sdk.oncreate.html index 05ba4c99..2d04e7b3 100644 --- a/docs/karte-action-sdk.oncreate.html +++ b/docs/karte-action-sdk.oncreate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > onCreate

onCreate() function

アクションが作成 (create) される前にフックする関数

Signature:

typescript
declare function onCreate<Props extends ModalProps, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
 

Parameters

ParameterTypeDescription
fnActionHook<Props, Variables & ActionVariables>呼び出されるフック関数

Returns:

void

- + diff --git a/docs/karte-action-sdk.ondestory.html b/docs/karte-action-sdk.ondestory.html index ef9ff569..f802cc01 100644 --- a/docs/karte-action-sdk.ondestory.html +++ b/docs/karte-action-sdk.ondestory.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > onDestory

onDestory variable

エレメントを破棄したときに実行される関数の登録

Signature:

typescript
onDestory: typeof onDestorySvelte
 
- + diff --git a/docs/karte-action-sdk.ondestroy.html b/docs/karte-action-sdk.ondestroy.html index 77103fd2..ad0413a0 100644 --- a/docs/karte-action-sdk.ondestroy.html +++ b/docs/karte-action-sdk.ondestroy.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > onDestroy

onDestroy() function

アクションが破棄 (destroy) される前にフックする関数

Signature:

typescript
declare function onDestroy<Props extends ModalProps, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
 

Parameters

ParameterTypeDescription
fnActionHook<Props, Variables & ActionVariables>呼び出されるフック関数

Returns:

void

- + diff --git a/docs/karte-action-sdk.onmount.html b/docs/karte-action-sdk.onmount.html index 2d77ab59..c66680bd 100644 --- a/docs/karte-action-sdk.onmount.html +++ b/docs/karte-action-sdk.onmount.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > onMount

onMount variable

エレメントをマウントしたときに実行される関数の登録

Signature:

typescript
onMount: typeof onMountSvelte
 
- + diff --git a/docs/karte-action-sdk.onscroll.html b/docs/karte-action-sdk.onscroll.html index 5d0ffc5f..c9171976 100644 --- a/docs/karte-action-sdk.onscroll.html +++ b/docs/karte-action-sdk.onscroll.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > onScroll

onScroll() function

スクロール率が達したときに呼び出すコールバックを登録します

Signature:

typescript
declare function onScroll(rate: number | number[], fn: OnScrollFunction): () => void;
 

Parameters

ParameterTypeDescription
ratenumber | number[]スクロール率。この値は viewport でのスクロールのパーセンテージ
fnOnScrollFunctionスクロール率が達したときに呼び出されるコールバック関数

Returns:

() => void

スクロール率によって呼び出されるコールバックを停止する関数を返します

- + diff --git a/docs/karte-action-sdk.onscrollcontext.deltarate.html b/docs/karte-action-sdk.onscrollcontext.deltarate.html index 32cbbbab..9139d5ce 100644 --- a/docs/karte-action-sdk.onscrollcontext.deltarate.html +++ b/docs/karte-action-sdk.onscrollcontext.deltarate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > OnScrollContext > deltaRate

OnScrollContext.deltaRate property

現在のスクロール率と前のスクロール率との差分値

Signature:

typescript
deltaRate: number;
 
- + diff --git a/docs/karte-action-sdk.onscrollcontext.direction.html b/docs/karte-action-sdk.onscrollcontext.direction.html index f62e0ae5..cc4dc299 100644 --- a/docs/karte-action-sdk.onscrollcontext.direction.html +++ b/docs/karte-action-sdk.onscrollcontext.direction.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > OnScrollContext > direction

OnScrollContext.direction property

スクロール方向

Signature:

typescript
direction: ScrollDirection;
 
- + diff --git a/docs/karte-action-sdk.onscrollcontext.html b/docs/karte-action-sdk.onscrollcontext.html index 98ba7998..f27f2ba3 100644 --- a/docs/karte-action-sdk.onscrollcontext.html +++ b/docs/karte-action-sdk.onscrollcontext.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > OnScrollContext

OnScrollContext interface

onScroll() のスクロールコンテキスト情報

Signature:

typescript
interface OnScrollContext 
 

Remarks

このコンテキスト情報は、OnScrollFunction が呼び出されたタイミングの情報が格納されています

Properties

PropertyModifiersTypeDescription
deltaRatenumber現在のスクロール率と前のスクロール率との差分値
directionScrollDirectionスクロール方向
previousRatenumber前のスクロール率
ratenumberonScroll() によって指定されたスクロール率
scrollRatenumberページのスクロール率
- + diff --git a/docs/karte-action-sdk.onscrollcontext.previousrate.html b/docs/karte-action-sdk.onscrollcontext.previousrate.html index d22de75c..31c26fd2 100644 --- a/docs/karte-action-sdk.onscrollcontext.previousrate.html +++ b/docs/karte-action-sdk.onscrollcontext.previousrate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > OnScrollContext > previousRate

OnScrollContext.previousRate property

前のスクロール率

Signature:

typescript
previousRate: number;
 
- + diff --git a/docs/karte-action-sdk.onscrollcontext.rate.html b/docs/karte-action-sdk.onscrollcontext.rate.html index a5ee0430..391016af 100644 --- a/docs/karte-action-sdk.onscrollcontext.rate.html +++ b/docs/karte-action-sdk.onscrollcontext.rate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > OnScrollContext > rate

OnScrollContext.rate property

onScroll() によって指定されたスクロール率

Signature:

typescript
rate: number;
 
- + diff --git a/docs/karte-action-sdk.onscrollcontext.scrollrate.html b/docs/karte-action-sdk.onscrollcontext.scrollrate.html index dd468047..e23516e4 100644 --- a/docs/karte-action-sdk.onscrollcontext.scrollrate.html +++ b/docs/karte-action-sdk.onscrollcontext.scrollrate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > OnScrollContext > scrollRate

OnScrollContext.scrollRate property

ページのスクロール率

Signature:

typescript
scrollRate: number;
 
- + diff --git a/docs/karte-action-sdk.onscrollfunction.html b/docs/karte-action-sdk.onscrollfunction.html index 26ecf1f7..0ac46f2a 100644 --- a/docs/karte-action-sdk.onscrollfunction.html +++ b/docs/karte-action-sdk.onscrollfunction.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > OnScrollFunction

OnScrollFunction type

onScroll() によって呼び出されるコールバック関数

Signature:

typescript
type OnScrollFunction = (ctx: OnScrollContext) => boolean;
 

References: OnScrollContext

- + diff --git a/docs/karte-action-sdk.onshow.html b/docs/karte-action-sdk.onshow.html index deabe892..f0fc1a33 100644 --- a/docs/karte-action-sdk.onshow.html +++ b/docs/karte-action-sdk.onshow.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > onShow

onShow() function

アクションが表示 (show) された後にフックする関数

Signature:

typescript
declare function onShow<Props extends ModalProps$1, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
 

Parameters

ParameterTypeDescription
fnActionHook<Props, Variables & ActionVariables>呼び出されるフック関数

Returns:

void

- + diff --git a/docs/karte-action-sdk.ontime.html b/docs/karte-action-sdk.ontime.html index 517d5c2f..250005fe 100644 --- a/docs/karte-action-sdk.ontime.html +++ b/docs/karte-action-sdk.ontime.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > onTime

onTime() function

指定した時間の経過後に呼び出すコールバックを登録します

Signature:

typescript
declare function onTime(time: number, fn: Function): () => void;
 

Parameters

ParameterTypeDescription
timenumberコールバックを呼び出すまでの時間。単位はミリセカンド(ms)
fnFunction指定した時間が経過後に呼び出されるコールバック関数

Returns:

() => void

コールバックを呼び出すためのタイマーを停止する関数を返します

- + diff --git a/docs/karte-action-sdk.publishfunction.html b/docs/karte-action-sdk.publishfunction.html index 4e1ec1bf..df9ea441 100644 --- a/docs/karte-action-sdk.publishfunction.html +++ b/docs/karte-action-sdk.publishfunction.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > PublishFunction

PublishFunction type

アクションの publish 関数

Signature:

typescript
type PublishFunction = (topic: string, values?: any) => void;
 
- + diff --git a/docs/karte-action-sdk.reseteventhandlers.html b/docs/karte-action-sdk.reseteventhandlers.html index 47871de5..b9127e3c 100644 --- a/docs/karte-action-sdk.reseteventhandlers.html +++ b/docs/karte-action-sdk.reseteventhandlers.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > resetEventHandlers

resetEventHandlers() function

イベントハンドラーをリセットする

Signature:

typescript
declare function resetEventHandlers(): void;
 

Returns:

void

- + diff --git a/docs/karte-action-sdk.resetvariables.html b/docs/karte-action-sdk.resetvariables.html index 464c72fb..fe8dff09 100644 --- a/docs/karte-action-sdk.resetvariables.html +++ b/docs/karte-action-sdk.resetvariables.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > resetVariables

resetVariables() function

変数をリセットする

Signature:

typescript
declare function resetVariables(): void;
 

Returns:

void

- + diff --git a/docs/karte-action-sdk.scrolldirection.html b/docs/karte-action-sdk.scrolldirection.html index 4df7568b..f03dc78b 100644 --- a/docs/karte-action-sdk.scrolldirection.html +++ b/docs/karte-action-sdk.scrolldirection.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > ScrollDirection

ScrollDirection type

スクロール方向

Signature:

typescript
type ScrollDirection = "up" | "down";
 
- + diff --git a/docs/karte-action-sdk.sendfunction.html b/docs/karte-action-sdk.sendfunction.html index 365a1a35..b112179d 100644 --- a/docs/karte-action-sdk.sendfunction.html +++ b/docs/karte-action-sdk.sendfunction.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > SendFunction

SendFunction type

アクションの send 関数

Signature:

typescript
type SendFunction = (event_name: string, values?: any) => void;
 
- + diff --git a/docs/karte-action-sdk.seteventhandlers.html b/docs/karte-action-sdk.seteventhandlers.html index fd532ef2..35e1f50d 100644 --- a/docs/karte-action-sdk.seteventhandlers.html +++ b/docs/karte-action-sdk.seteventhandlers.html @@ -18,7 +18,7 @@ [key: string]: ActionEventHandler; };

Parameters

ParameterTypeDescription
handlers{ [key: string]: ActionEventHandler; }登録するイベントハンドラー

Returns:

{ [key: string]: ActionEventHandler; }

Remarks

登録したイベントハンドラーは、ビジュアルエディタでアクション本体とのテキストボタンのクリック時の動作で利用できます。

- + diff --git a/docs/karte-action-sdk.setsetting.html b/docs/karte-action-sdk.setsetting.html index 07f67572..f9f32947 100644 --- a/docs/karte-action-sdk.setsetting.html +++ b/docs/karte-action-sdk.setsetting.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > setSetting

setSetting() function

アクション設定を更新する

Signature:

typescript
declare function setSetting(setting: ActionSetting): ActionSetting;
 

Parameters

ParameterTypeDescription
settingActionSetting更新するアクション設定

Returns:

ActionSetting

新しいアクション設定

- + diff --git a/docs/karte-action-sdk.setstate.html b/docs/karte-action-sdk.setstate.html index d4f332f4..ca813520 100644 --- a/docs/karte-action-sdk.setstate.html +++ b/docs/karte-action-sdk.setstate.html @@ -16,7 +16,7 @@ disableInPreview: boolean; }): void;

Parameters

ParameterTypeDescription
stateIdstring表示するステートID
options(Optional) オプション。options.disableInPreviewでプレビュー時のステート遷移を無効化できます。

Returns:

void

- + diff --git a/docs/karte-action-sdk.showaction.html b/docs/karte-action-sdk.showaction.html index d91c793d..40c46eae 100644 --- a/docs/karte-action-sdk.showaction.html +++ b/docs/karte-action-sdk.showaction.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > showAction

showAction() function

アクションを表示する

Signature:

typescript
declare function showAction(): void;
 

Returns:

void

- + diff --git a/docs/karte-action-sdk.systemconfig.html b/docs/karte-action-sdk.systemconfig.html index ed205c4b..03c2832e 100644 --- a/docs/karte-action-sdk.systemconfig.html +++ b/docs/karte-action-sdk.systemconfig.html @@ -18,7 +18,7 @@ shortenId?: string; }; - + diff --git a/docs/karte-action-sdk.tick.html b/docs/karte-action-sdk.tick.html index e0a843e7..f5a04d04 100644 --- a/docs/karte-action-sdk.tick.html +++ b/docs/karte-action-sdk.tick.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > tick

tick variable

エレメントのライフサイクルを進める

Signature:

typescript
tick: typeof tickSvelte
 
- + diff --git a/docs/karte-action-sdk.widget.actionchangestatehook.html b/docs/karte-action-sdk.widget.actionchangestatehook.html index 8739e94b..14fc66e4 100644 --- a/docs/karte-action-sdk.widget.actionchangestatehook.html +++ b/docs/karte-action-sdk.widget.actionchangestatehook.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionChangeStateHook

widget.ActionChangeStateHook type

アクションのライフサイクル changeState で呼び出されるフック関数

Signature:

typescript
type ActionChangeStateHook<Props, Variables> = (props: Parameters<ActionHook<Props, Variables & ActionVariables>>[0], newState: string) => void | Promise<void>;
 
- + diff --git a/docs/karte-action-sdk.widget.actionclosehook.html b/docs/karte-action-sdk.widget.actionclosehook.html index c404b9bd..cd580366 100644 --- a/docs/karte-action-sdk.widget.actionclosehook.html +++ b/docs/karte-action-sdk.widget.actionclosehook.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionCloseHook

widget.ActionCloseHook type

アクションのライフサイクル close で呼び出されるフックする関数

Signature:

typescript
type ActionCloseHook<Props extends ModalProps, Variables> = (props: Parameters<ActionHook<Props, Variables & ActionVariables>>[0], trigger: CloseTrigger) => void | Promise<void>;
 
- + diff --git a/docs/karte-action-sdk.widget.actioneventhandler.html b/docs/karte-action-sdk.widget.actioneventhandler.html index fa5fb50a..fe23d920 100644 --- a/docs/karte-action-sdk.widget.actioneventhandler.html +++ b/docs/karte-action-sdk.widget.actioneventhandler.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionEventHandler

widget.ActionEventHandler type

アクションのイベントハンドラ

Signature:

typescript
type ActionEventHandler = (...args: any[]) => any | Promise<any>;
 
- + diff --git a/docs/karte-action-sdk.widget.actionhook.html b/docs/karte-action-sdk.widget.actionhook.html index 8233ed2d..d4476fc7 100644 --- a/docs/karte-action-sdk.widget.actionhook.html +++ b/docs/karte-action-sdk.widget.actionhook.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionHook

widget.ActionHook type

アクションのライフサイクルで呼び出されるフック

Signature:

typescript
type ActionHook<Props, Variables> = (props: ActionProps<Props, Variables & ActionVariables>) => void | Promise<void>;
 
- + diff --git a/docs/karte-action-sdk.widget.actionoptions.context.html b/docs/karte-action-sdk.widget.actionoptions.context.html index 50aa9692..28cd613e 100644 --- a/docs/karte-action-sdk.widget.actionoptions.context.html +++ b/docs/karte-action-sdk.widget.actionoptions.context.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionOptions > context

widget.ActionOptions.context property

アクション実行時のコンテキスト

Signature:

typescript
context: ActionRunnerContext;
 
- + diff --git a/docs/karte-action-sdk.widget.actionoptions.html b/docs/karte-action-sdk.widget.actionoptions.html index b3942674..a11301f5 100644 --- a/docs/karte-action-sdk.widget.actionoptions.html +++ b/docs/karte-action-sdk.widget.actionoptions.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionOptions

widget.ActionOptions interface

create() 向けのオプション

Signature:

typescript
interface ActionOptions<Props, Variables, VariablesQuery> 
 

Properties

PropertyModifiersTypeDescription
contextActionRunnerContextアクション実行時のコンテキスト
karteTemplate?{ [key: string]: any; }(Optional) KARTEテンプレートの情報
localVariablesQuery?VariablesQuery(Optional) アクションで使用されるアクション実行時に取得される変数
onCreate?ActionHook<Props, Variables & ActionVariables>(Optional) アクションが作成されているときにフックされる onCreate()
props?Props(Optional) アクションで使用されるプロパティ
publish?PublishFunction(Optional) アクション内でタグのQueueにリクエストを発行する関数
send?SendFunction(Optional) アクション内でイベントを発火する関数
variables?Variables(Optional) アクションで使用される解析時に取得される変数
- + diff --git a/docs/karte-action-sdk.widget.actionoptions.kartetemplate.html b/docs/karte-action-sdk.widget.actionoptions.kartetemplate.html index ee1e759f..146fec6a 100644 --- a/docs/karte-action-sdk.widget.actionoptions.kartetemplate.html +++ b/docs/karte-action-sdk.widget.actionoptions.kartetemplate.html @@ -16,7 +16,7 @@ [key: string]: any; }; - + diff --git a/docs/karte-action-sdk.widget.actionoptions.localvariablesquery.html b/docs/karte-action-sdk.widget.actionoptions.localvariablesquery.html index 5c1de0e7..1479198e 100644 --- a/docs/karte-action-sdk.widget.actionoptions.localvariablesquery.html +++ b/docs/karte-action-sdk.widget.actionoptions.localvariablesquery.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionOptions > localVariablesQuery

widget.ActionOptions.localVariablesQuery property

アクションで使用されるアクション実行時に取得される変数

Signature:

typescript
localVariablesQuery?: VariablesQuery;
 
- + diff --git a/docs/karte-action-sdk.widget.actionoptions.oncreate.html b/docs/karte-action-sdk.widget.actionoptions.oncreate.html index 57e6ed87..3a664cb9 100644 --- a/docs/karte-action-sdk.widget.actionoptions.oncreate.html +++ b/docs/karte-action-sdk.widget.actionoptions.oncreate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionOptions > onCreate

widget.ActionOptions.onCreate property

アクションが作成されているときにフックされる onCreate()

Signature:

typescript
onCreate?: ActionHook<Props, Variables & ActionVariables>;
 
- + diff --git a/docs/karte-action-sdk.widget.actionoptions.props.html b/docs/karte-action-sdk.widget.actionoptions.props.html index dff876d2..ade4113f 100644 --- a/docs/karte-action-sdk.widget.actionoptions.props.html +++ b/docs/karte-action-sdk.widget.actionoptions.props.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionOptions > props

widget.ActionOptions.props property

アクションで使用されるプロパティ

Signature:

typescript
props?: Props;
 
- + diff --git a/docs/karte-action-sdk.widget.actionoptions.publish.html b/docs/karte-action-sdk.widget.actionoptions.publish.html index 633b15f3..d834ab34 100644 --- a/docs/karte-action-sdk.widget.actionoptions.publish.html +++ b/docs/karte-action-sdk.widget.actionoptions.publish.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionOptions > publish

widget.ActionOptions.publish property

アクション内でタグのQueueにリクエストを発行する関数

Signature:

typescript
publish?: PublishFunction;
 
- + diff --git a/docs/karte-action-sdk.widget.actionoptions.send.html b/docs/karte-action-sdk.widget.actionoptions.send.html index e7cb8d14..a24c3db4 100644 --- a/docs/karte-action-sdk.widget.actionoptions.send.html +++ b/docs/karte-action-sdk.widget.actionoptions.send.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionOptions > send

widget.ActionOptions.send property

アクション内でイベントを発火する関数

Signature:

typescript
send?: SendFunction;
 
- + diff --git a/docs/karte-action-sdk.widget.actionoptions.variables.html b/docs/karte-action-sdk.widget.actionoptions.variables.html index 9c9f1c70..4f99d976 100644 --- a/docs/karte-action-sdk.widget.actionoptions.variables.html +++ b/docs/karte-action-sdk.widget.actionoptions.variables.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionOptions > variables

widget.ActionOptions.variables property

アクションで使用される解析時に取得される変数

Signature:

typescript
variables?: Variables;
 
- + diff --git a/docs/karte-action-sdk.widget.actionprops.data.html b/docs/karte-action-sdk.widget.actionprops.data.html index 4f3702f8..705f9c9b 100644 --- a/docs/karte-action-sdk.widget.actionprops.data.html +++ b/docs/karte-action-sdk.widget.actionprops.data.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionProps > data

widget.ActionProps.data property

アクションで使用されるデータ

Signature:

typescript
data: Props & Variables & ActionVariables;
 
- + diff --git a/docs/karte-action-sdk.widget.actionprops.html b/docs/karte-action-sdk.widget.actionprops.html index aa0a30a9..371fc6bc 100644 --- a/docs/karte-action-sdk.widget.actionprops.html +++ b/docs/karte-action-sdk.widget.actionprops.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionProps

widget.ActionProps interface

アクションのプロパティ

Signature:

typescript
interface ActionProps<Props, Variables> 
 

Properties

PropertyModifiersTypeDescription
dataProps & Variables & ActionVariablesアクションで使用されるデータ
onChangeState?ActionChangeStateHook<Props, Variables & ActionVariables>(Optional) アクションのステートが変更されたときにフックされる onChangeState()
onShow?ActionHook<Props, Variables & ActionVariables>(Optional) アクションが表示されたときにフックされる onShow()
publishPublishFunctionアクション内でタグのQueueにリクエストを発行する関数
sendSendFunctionアクションでイベントがトリガーされたときに受信するための関数
- + diff --git a/docs/karte-action-sdk.widget.actionprops.onchangestate.html b/docs/karte-action-sdk.widget.actionprops.onchangestate.html index 633f20d1..c04bde7d 100644 --- a/docs/karte-action-sdk.widget.actionprops.onchangestate.html +++ b/docs/karte-action-sdk.widget.actionprops.onchangestate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionProps > onChangeState

widget.ActionProps.onChangeState property

アクションのステートが変更されたときにフックされる onChangeState()

Signature:

typescript
onChangeState?: ActionChangeStateHook<Props, Variables & ActionVariables>;
 
- + diff --git a/docs/karte-action-sdk.widget.actionprops.onshow.html b/docs/karte-action-sdk.widget.actionprops.onshow.html index ed125b26..ace1ce16 100644 --- a/docs/karte-action-sdk.widget.actionprops.onshow.html +++ b/docs/karte-action-sdk.widget.actionprops.onshow.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionProps > onShow

widget.ActionProps.onShow property

アクションが表示されたときにフックされる onShow()

Signature:

typescript
onShow?: ActionHook<Props, Variables & ActionVariables>;
 
- + diff --git a/docs/karte-action-sdk.widget.actionprops.publish.html b/docs/karte-action-sdk.widget.actionprops.publish.html index 87e4607a..9906b4c3 100644 --- a/docs/karte-action-sdk.widget.actionprops.publish.html +++ b/docs/karte-action-sdk.widget.actionprops.publish.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionProps > publish

widget.ActionProps.publish property

アクション内でタグのQueueにリクエストを発行する関数

Signature:

typescript
publish: PublishFunction;
 
- + diff --git a/docs/karte-action-sdk.widget.actionprops.send.html b/docs/karte-action-sdk.widget.actionprops.send.html index a1c5107f..230eabfa 100644 --- a/docs/karte-action-sdk.widget.actionprops.send.html +++ b/docs/karte-action-sdk.widget.actionprops.send.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionProps > send

widget.ActionProps.send property

アクションでイベントがトリガーされたときに受信するための関数

Signature:

typescript
send: SendFunction;
 
- + diff --git a/docs/karte-action-sdk.widget.actionrunnercontext.html b/docs/karte-action-sdk.widget.actionrunnercontext.html index e66d5d6e..23c3786a 100644 --- a/docs/karte-action-sdk.widget.actionrunnercontext.html +++ b/docs/karte-action-sdk.widget.actionrunnercontext.html @@ -17,7 +17,7 @@ target?: "web" | "native"; }; - + diff --git a/docs/karte-action-sdk.widget.actionsetting.html b/docs/karte-action-sdk.widget.actionsetting.html index a834efee..348798c7 100644 --- a/docs/karte-action-sdk.widget.actionsetting.html +++ b/docs/karte-action-sdk.widget.actionsetting.html @@ -18,7 +18,7 @@ initialState?: string; }; - + diff --git a/docs/karte-action-sdk.widget.actiontablequeryparam.html b/docs/karte-action-sdk.widget.actiontablequeryparam.html index 9cf58fed..a6087cb8 100644 --- a/docs/karte-action-sdk.widget.actiontablequeryparam.html +++ b/docs/karte-action-sdk.widget.actiontablequeryparam.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionTableQueryParam

widget.ActionTableQueryParam type

Signature:

typescript
type ActionTableQueryParam = string | number | boolean | Date;
 
- + diff --git a/docs/karte-action-sdk.widget.actiontablequeryparams.html b/docs/karte-action-sdk.widget.actiontablequeryparams.html index e2d8f744..c948a221 100644 --- a/docs/karte-action-sdk.widget.actiontablequeryparams.html +++ b/docs/karte-action-sdk.widget.actiontablequeryparams.html @@ -16,7 +16,7 @@ [key: string]: ActionTableQueryParam | ActionTableQueryParam[]; }; - + diff --git a/docs/karte-action-sdk.widget.actiontableresult.html b/docs/karte-action-sdk.widget.actiontableresult.html index 5b751dcf..465d3d8e 100644 --- a/docs/karte-action-sdk.widget.actiontableresult.html +++ b/docs/karte-action-sdk.widget.actiontableresult.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ActionTableResult

widget.ActionTableResult type

Signature:

typescript
type ActionTableResult = number | string | boolean | Date | null | undefined;
 
- + diff --git a/docs/karte-action-sdk.widget.actionvariables.html b/docs/karte-action-sdk.widget.actionvariables.html index 6fb0dff0..47e597ee 100644 --- a/docs/karte-action-sdk.widget.actionvariables.html +++ b/docs/karte-action-sdk.widget.actionvariables.html @@ -16,7 +16,7 @@ [key: string]: any; }; - + diff --git a/docs/karte-action-sdk.widget.applycss.html b/docs/karte-action-sdk.widget.applycss.html index 46edebcd..a42034aa 100644 --- a/docs/karte-action-sdk.widget.applycss.html +++ b/docs/karte-action-sdk.widget.applycss.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > applyCss

widget.applyCss() function

アクションに CSS を適用する

Signature:

typescript
function applyCss(css: string): Promise<HTMLStyleElement>;
 

Parameters

ParameterTypeDescription
cssstring適用する CSS

Returns:

Promise<HTMLStyleElement>

適用された style 要素を返す Promise

- + diff --git a/docs/karte-action-sdk.widget.changevalcallback.html b/docs/karte-action-sdk.widget.changevalcallback.html index 03ccf911..812dee5d 100644 --- a/docs/karte-action-sdk.widget.changevalcallback.html +++ b/docs/karte-action-sdk.widget.changevalcallback.html @@ -18,7 +18,7 @@ key: any; }) => void; - + diff --git a/docs/karte-action-sdk.widget.closeaction.html b/docs/karte-action-sdk.widget.closeaction.html index fd27e473..46ea0928 100644 --- a/docs/karte-action-sdk.widget.closeaction.html +++ b/docs/karte-action-sdk.widget.closeaction.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > closeAction

widget.closeAction() function

アクションを閉じる

Signature:

typescript
function closeAction(trigger?: CloseTrigger): void;
 

Parameters

ParameterTypeDescription
triggerCloseTrigger(Optional) 閉じた時のトリガー。デフォルト 'none'

Returns:

void

- + diff --git a/docs/karte-action-sdk.widget.closetrigger.html b/docs/karte-action-sdk.widget.closetrigger.html index 9cafa2b1..89f30de1 100644 --- a/docs/karte-action-sdk.widget.closetrigger.html +++ b/docs/karte-action-sdk.widget.closetrigger.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > CloseTrigger

widget.CloseTrigger type

閉じるアクショントリガー

Signature:

typescript
type CloseTrigger = "button" | "overlay" | "auto" | "none";
 
- + diff --git a/docs/karte-action-sdk.widget.collection.html b/docs/karte-action-sdk.widget.collection.html index 7730a43d..8bc60fdf 100644 --- a/docs/karte-action-sdk.widget.collection.html +++ b/docs/karte-action-sdk.widget.collection.html @@ -20,7 +20,7 @@ set(key: string, value: string, cb: (err: Error | null) => void): void; };

Parameters

ParameterTypeDescription
configCollectionConfig設定情報

Returns:

{ get(key: string | Array<string>, cb: (err: Error | null, items?: ActionTableResult | Array<ActionTableResult>) => void): void; getByQuery(query_name: string, params: ActionTableQueryParams, options: { ignore_fields?: string[]; } | null | undefined, cb: (err: Error | null, items?: Array<ActionTableResult>) => void): void; set(key: string, value: string, cb: (err: Error | null) => void): void; }

メソッドを返します

- + diff --git a/docs/karte-action-sdk.widget.collection_0.html b/docs/karte-action-sdk.widget.collection_0.html index 5755691f..aefd8274 100644 --- a/docs/karte-action-sdk.widget.collection_0.html +++ b/docs/karte-action-sdk.widget.collection_0.html @@ -22,7 +22,7 @@ set(key: string, value: string, cb: (err: Error) => void): void; };

Parameters

ParameterTypeDescription
tablestringアクションテーブル名

Returns:

{ get(key: string | string[], cb: (err: Error, items?: (string | number | boolean | Date) | (string | number | boolean | Date)[]) => void): void; getByQuery(query_name: string, params: { [key: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[]; }, options: { ignore_fields?: string[]; }, cb: (err: Error, items?: (string | number | boolean | Date)[]) => void): void; set(key: string, value: string, cb: (err: Error) => void): void; }

- + diff --git a/docs/karte-action-sdk.widget.collectionconfig.html b/docs/karte-action-sdk.widget.collectionconfig.html index f69f75e9..e64471ea 100644 --- a/docs/karte-action-sdk.widget.collectionconfig.html +++ b/docs/karte-action-sdk.widget.collectionconfig.html @@ -18,7 +18,7 @@ endpoint?: string; }; - + diff --git a/docs/karte-action-sdk.widget.eventcallback.html b/docs/karte-action-sdk.widget.eventcallback.html index ae0ba3b2..1f77d75f 100644 --- a/docs/karte-action-sdk.widget.eventcallback.html +++ b/docs/karte-action-sdk.widget.eventcallback.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > EventCallback

widget.EventCallback type

Signature:

typescript
type EventCallback = (event: any) => void;
 
- + diff --git a/docs/karte-action-sdk.widget.getactionroot.html b/docs/karte-action-sdk.widget.getactionroot.html index 689a1da0..1ab98158 100644 --- a/docs/karte-action-sdk.widget.getactionroot.html +++ b/docs/karte-action-sdk.widget.getactionroot.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > getActionRoot

widget.getActionRoot() function

アクションのルートの DOM 要素を取得する

Signature:

typescript
function getActionRoot(): ShadowRoot | null;
 

Returns:

ShadowRoot | null

アクションがルートの DOM 要素 を持つ場合は DOM 要素を返します。ない場合は null を返します

- + diff --git a/docs/karte-action-sdk.widget.getcssvariables.html b/docs/karte-action-sdk.widget.getcssvariables.html index 328ebdeb..2a384a9f 100644 --- a/docs/karte-action-sdk.widget.getcssvariables.html +++ b/docs/karte-action-sdk.widget.getcssvariables.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > getCssVariables

widget.getCssVariables() function

Signature:

typescript
function getCssVariables<Props extends ModalProps, Variables>(data: Writable<Props & Variables & ActionVariables & VariableQuery>): string;
 

Parameters

ParameterTypeDescription
dataWritable<Props & Variables & ActionVariables & VariableQuery>

Returns:

string

- + diff --git a/docs/karte-action-sdk.widget.getlocalstore.html b/docs/karte-action-sdk.widget.getlocalstore.html index 07dcb936..ec175b46 100644 --- a/docs/karte-action-sdk.widget.getlocalstore.html +++ b/docs/karte-action-sdk.widget.getlocalstore.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > getLocalStore

widget.getLocalStore() function

ページをまたぐ変数を取得設定する

Signature:

typescript
function getLocalStore(key: string): any | undefined;
 

Parameters

ParameterTypeDescription
keystring変数のキー

Returns:

any | undefined

変数

- + diff --git a/docs/karte-action-sdk.widget.getmemorystore.html b/docs/karte-action-sdk.widget.getmemorystore.html index 7fe954ba..746ea0de 100644 --- a/docs/karte-action-sdk.widget.getmemorystore.html +++ b/docs/karte-action-sdk.widget.getmemorystore.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > getMemoryStore

widget.getMemoryStore() function

ページ内の変数を取定する

Signature:

typescript
function getMemoryStore(key: string): any;
 

Parameters

ParameterTypeDescription
keystring変数のキー

Returns:

any

変数

- + diff --git a/docs/karte-action-sdk.widget.getstate.html b/docs/karte-action-sdk.widget.getstate.html index 7af9ba23..8abbdbe9 100644 --- a/docs/karte-action-sdk.widget.getstate.html +++ b/docs/karte-action-sdk.widget.getstate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > getState

widget.getState() function

現在のステートを取得する

Signature:

typescript
function getState(): string;
 

Returns:

string

ステートID

- + diff --git a/docs/karte-action-sdk.widget.getval.html b/docs/karte-action-sdk.widget.getval.html index b369404a..4ea7eddc 100644 --- a/docs/karte-action-sdk.widget.getval.html +++ b/docs/karte-action-sdk.widget.getval.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > getVal

widget.getVal() function

変数を取得する

Signature:

typescript
function getVal(name: string): any;
 

Parameters

ParameterTypeDescription
namestring変数名

Returns:

any

変数値

- + diff --git a/docs/karte-action-sdk.widget.html b/docs/karte-action-sdk.widget.html index 483ce8bd..9a19023a 100644 --- a/docs/karte-action-sdk.widget.html +++ b/docs/karte-action-sdk.widget.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget

widget namespace

Signature:

typescript
declare namespace widget 
 

Functions

FunctionDescription
applyCss(css)アクションに CSS を適用する
closeAction(trigger)アクションを閉じる
collection(config)アクションテーブルを管理するメソッドを取得する
collection$0(table)アクションテーブルを操作するオブジェクト
getActionRoot()アクションのルートの DOM 要素を取得する
getCssVariables(data)
getLocalStore(key)ページをまたぐ変数を取得設定する
getMemoryStore(key)ページ内の変数を取定する
getState()現在のステートを取得する
getVal(name)変数を取得する
loadStyle(href)アクションにグローバルなスタイルを読み込む
method(name, callback)WEBのイベントが発生したときに実行されるコールバック関数を設定する
on(name, callback)Widgetのイベントが発生したときに実行されるコールバック関数を設定する
onChangeState(fn)アクションのステートが変更された (changeState) 後にフックする関数
onChangeVal(name, callback)変数が変更されたときに実行されるコールバック関数を設定する
onClose(fn)アクションがクローズ (close) される前にフックする関数
onShow(fn)アクションが表示 (show) された後にフックする関数
setLocalStore(key, value, options)ページをまたぐ変数を設定する
setMemoryStore(key, value)ページ内の変数を設定する
setState(stateId)現在のステートを設定する
setVal(name, value)変数を設定する
showAction()アクションを表示する

Interfaces

InterfaceDescription
ActionOptionscreate() 向けのオプション
ActionPropsアクションのプロパティ

Variables

VariableDescription
storage

Type Aliases

Type AliasDescription
ActionChangeStateHookアクションのライフサイクル changeState で呼び出されるフック関数
ActionCloseHookアクションのライフサイクル close で呼び出されるフックする関数
ActionEventHandlerアクションのイベントハンドラ
ActionHookアクションのライフサイクルで呼び出されるフック
ActionRunnerContextアクション実行時のコンテキスト
ActionSettingアクション設定
ActionTableQueryParam
ActionTableQueryParams
ActionTableResult
ActionVariablesアクションの変数
ChangeValCallback
CloseTrigger閉じるアクショントリガー
CollectionConfigアクションテーブルの設定情報
EventCallback
ModalProps
PublishFunctionアクションの publish 関数
SendFunctionアクションの send 関数
SystemConfigKARTE のシステム設定情報
WidgetEventName
- + diff --git a/docs/karte-action-sdk.widget.loadstyle.html b/docs/karte-action-sdk.widget.loadstyle.html index 3038228e..659cb601 100644 --- a/docs/karte-action-sdk.widget.loadstyle.html +++ b/docs/karte-action-sdk.widget.loadstyle.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > loadStyle

widget.loadStyle() function

アクションにグローバルなスタイルを読み込む

Signature:

typescript
function loadStyle(href: string): Promise<void>;
 

Parameters

ParameterTypeDescription
hrefstringstyle ファイルのリンク URL

Returns:

Promise<void>

- + diff --git a/docs/karte-action-sdk.widget.method.html b/docs/karte-action-sdk.widget.method.html index cf5ff5ca..cbf7d1fc 100644 --- a/docs/karte-action-sdk.widget.method.html +++ b/docs/karte-action-sdk.widget.method.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > method

widget.method() function

WEBのイベントが発生したときに実行されるコールバック関数を設定する

Signature:

typescript
function method(name: string, callback: EventCallback): void;
 

Parameters

ParameterTypeDescription
namestringWEBのイベント名
callbackEventCallbackコールバック関数

Returns:

void

- + diff --git a/docs/karte-action-sdk.widget.modalprops.html b/docs/karte-action-sdk.widget.modalprops.html index fe02ca83..7aa51e3e 100644 --- a/docs/karte-action-sdk.widget.modalprops.html +++ b/docs/karte-action-sdk.widget.modalprops.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > ModalProps

widget.ModalProps type

Signature:

typescript
type ModalProps = Props;
 
- + diff --git a/docs/karte-action-sdk.widget.on.html b/docs/karte-action-sdk.widget.on.html index eb8ed767..2248e6eb 100644 --- a/docs/karte-action-sdk.widget.on.html +++ b/docs/karte-action-sdk.widget.on.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > on

widget.on() function

Widgetのイベントが発生したときに実行されるコールバック関数を設定する

Signature:

typescript
function on(name: WidgetEventName, callback: EventCallback): void;
 

Parameters

ParameterTypeDescription
nameWidgetEventNameWidgetのイベント名
callbackEventCallbackコールバック関数

Returns:

void

- + diff --git a/docs/karte-action-sdk.widget.onchangestate.html b/docs/karte-action-sdk.widget.onchangestate.html index a80b83ab..29a69670 100644 --- a/docs/karte-action-sdk.widget.onchangestate.html +++ b/docs/karte-action-sdk.widget.onchangestate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > onChangeState

widget.onChangeState() function

アクションのステートが変更された (changeState) 後にフックする関数

Signature:

typescript
function onChangeState<Props extends ModalProps, Variables>(fn: ActionChangeStateHook<Props, Variables & ActionVariables>): void;
 

Parameters

ParameterTypeDescription
fnActionChangeStateHook<Props, Variables & ActionVariables>呼び出されるフック関数

Returns:

void

- + diff --git a/docs/karte-action-sdk.widget.onchangeval.html b/docs/karte-action-sdk.widget.onchangeval.html index 498ed1d0..2e32fe4c 100644 --- a/docs/karte-action-sdk.widget.onchangeval.html +++ b/docs/karte-action-sdk.widget.onchangeval.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > onChangeVal

widget.onChangeVal() function

変数が変更されたときに実行されるコールバック関数を設定する

Signature:

typescript
function onChangeVal(name: string, callback: ChangeValCallback): void;
 

Parameters

ParameterTypeDescription
namestring変数名
callbackChangeValCallbackコールバック関数

Returns:

void

- + diff --git a/docs/karte-action-sdk.widget.onclose.html b/docs/karte-action-sdk.widget.onclose.html index 84a5b1f6..e2708f00 100644 --- a/docs/karte-action-sdk.widget.onclose.html +++ b/docs/karte-action-sdk.widget.onclose.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > onClose

widget.onClose() function

アクションがクローズ (close) される前にフックする関数

Signature:

typescript
function onClose<Props extends ModalProps, Variables>(fn: ActionCloseHook<Props, Variables & ActionVariables>): void;
 

Parameters

ParameterTypeDescription
fnActionCloseHook<Props, Variables & ActionVariables>呼び出されるフック関数

Returns:

void

- + diff --git a/docs/karte-action-sdk.widget.onshow.html b/docs/karte-action-sdk.widget.onshow.html index 9edc23b0..c164e315 100644 --- a/docs/karte-action-sdk.widget.onshow.html +++ b/docs/karte-action-sdk.widget.onshow.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > onShow

widget.onShow() function

アクションが表示 (show) された後にフックする関数

Signature:

typescript
function onShow<Props extends ModalProps, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
 

Parameters

ParameterTypeDescription
fnActionHook<Props, Variables & ActionVariables>呼び出されるフック関数

Returns:

void

- + diff --git a/docs/karte-action-sdk.widget.publishfunction.html b/docs/karte-action-sdk.widget.publishfunction.html index 44da9c6e..dacb61a0 100644 --- a/docs/karte-action-sdk.widget.publishfunction.html +++ b/docs/karte-action-sdk.widget.publishfunction.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > PublishFunction

widget.PublishFunction type

アクションの publish 関数

Signature:

typescript
type PublishFunction = (topic: string, values?: any) => void;
 
- + diff --git a/docs/karte-action-sdk.widget.sendfunction.html b/docs/karte-action-sdk.widget.sendfunction.html index 42293008..c15b5136 100644 --- a/docs/karte-action-sdk.widget.sendfunction.html +++ b/docs/karte-action-sdk.widget.sendfunction.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > SendFunction

widget.SendFunction type

アクションの send 関数

Signature:

typescript
type SendFunction = (event_name: string, values?: any) => void;
 
- + diff --git a/docs/karte-action-sdk.widget.setlocalstore.html b/docs/karte-action-sdk.widget.setlocalstore.html index 51c1fdd6..ba4f9d82 100644 --- a/docs/karte-action-sdk.widget.setlocalstore.html +++ b/docs/karte-action-sdk.widget.setlocalstore.html @@ -16,7 +16,7 @@ expire: number | boolean; }): void;

Parameters

ParameterTypeDescription
keystring変数のキー
valueany変数値
options(Optional)

Returns:

void

- + diff --git a/docs/karte-action-sdk.widget.setmemorystore.html b/docs/karte-action-sdk.widget.setmemorystore.html index 52d6463f..79b1e626 100644 --- a/docs/karte-action-sdk.widget.setmemorystore.html +++ b/docs/karte-action-sdk.widget.setmemorystore.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > setMemoryStore

widget.setMemoryStore() function

ページ内の変数を設定する

Signature:

typescript
function setMemoryStore(key: string, value: any): void;
 

Parameters

ParameterTypeDescription
keystring変数のキー
valueany変数値

Returns:

void

- + diff --git a/docs/karte-action-sdk.widget.setstate.html b/docs/karte-action-sdk.widget.setstate.html index 19da163f..90137a4e 100644 --- a/docs/karte-action-sdk.widget.setstate.html +++ b/docs/karte-action-sdk.widget.setstate.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > setState

widget.setState() function

現在のステートを設定する

Signature:

typescript
function setState(stateId: string): void;
 

Parameters

ParameterTypeDescription
stateIdstringステートID

Returns:

void

- + diff --git a/docs/karte-action-sdk.widget.setval.html b/docs/karte-action-sdk.widget.setval.html index 5e1b915f..afed980d 100644 --- a/docs/karte-action-sdk.widget.setval.html +++ b/docs/karte-action-sdk.widget.setval.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > setVal

widget.setVal() function

変数を設定する

Signature:

typescript
function setVal(name: string, value: any): void;
 

Parameters

ParameterTypeDescription
namestring変数名
valueany変数値

Returns:

void

- + diff --git a/docs/karte-action-sdk.widget.showaction.html b/docs/karte-action-sdk.widget.showaction.html index a5559277..98d57edb 100644 --- a/docs/karte-action-sdk.widget.showaction.html +++ b/docs/karte-action-sdk.widget.showaction.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > showAction

widget.showAction() function

アクションを表示する

Signature:

typescript
function showAction(): void;
 

Returns:

void

- + diff --git a/docs/karte-action-sdk.widget.storage.html b/docs/karte-action-sdk.widget.storage.html index 5b1d157b..7ab0c8c0 100644 --- a/docs/karte-action-sdk.widget.storage.html +++ b/docs/karte-action-sdk.widget.storage.html @@ -23,7 +23,7 @@ }; } - + diff --git a/docs/karte-action-sdk.widget.systemconfig.html b/docs/karte-action-sdk.widget.systemconfig.html index 96373f55..38cb86d6 100644 --- a/docs/karte-action-sdk.widget.systemconfig.html +++ b/docs/karte-action-sdk.widget.systemconfig.html @@ -18,7 +18,7 @@ shortenId?: string; }; - + diff --git a/docs/karte-action-sdk.widget.widgeteventname.html b/docs/karte-action-sdk.widget.widgeteventname.html index 273a4268..1d7bafd3 100644 --- a/docs/karte-action-sdk.widget.widgeteventname.html +++ b/docs/karte-action-sdk.widget.widgeteventname.html @@ -14,7 +14,7 @@
Skip to content
On this page

Home > @plaidev/karte-action-sdk > widget > WidgetEventName

widget.WidgetEventName type

Signature:

typescript
type WidgetEventName = "hide" | "clickBackdrop" | "destroyed";
 
- +