Inputman.GcComment

GcComment クラス

GcComment

階層

GcComment

コンストラクタ

constructor

プロパティ

イベント

コンストラクタ

constructor

new GcComment(el: HTMLElement, config?: GcCommentConfig): GcComment

var gcComment = new GC.InputMan.GcComment(document.getElementById("comment"), {
    commentMode: GC.InputMan.GcCommentMode.ChatMode,
    userInfo: {
         id: '1',
         name: 'user',
         avatar: './image/avatar.png'
    },
    editorConfig: {
         editorType: GC.InputMan.GcCommentEditorType.GcRichTextEditor,
    },
});

引数

el: HTMLElement

元のHTML要素。GcCommentはこの要素を非表示にし、下に新しい要素を生成します。
オプション config: GcCommentConfig

Configオブジェクト。GcCommentの表示モード、ユーザー情報、コメントエディタの設定をカスタマイズします。参照 GcCommentConfig

戻り値 GcComment

プロパティ

読み取り専用 activeEditor

activeEditor: IActiveCommentEditor | null

現在のGcCommentコントロールのエディターを取得します。コメントの新規追加または編集中でない場合は null を返します。

comments

comments: IComment[]

コメントを取得または設定します。

読み取り専用 displayComments

displayComments: IComment[]

表示中のコメントをすべて取得します。

enabled

enabled: boolean

コントロールやオブジェクトを有効にするかどうかを示す値を設定します。

height

height: number | string

GcCommentの高さを取得または設定します。

maxHeight

maxHeight: number | string

GcCommentの最大高を取得または設定します。

maxWidth

maxWidth: number | string

GcCommentの最大幅を取得または設定します。

minHeight

minHeight: number | string

GcCommentの最小高を取得または設定します。

minWidth

minWidth: number | string

GcCommentの最小幅を取得または設定します。

readOnly

readOnly: boolean

コントロールを読み取り専用モードにするかどうかを設定します。

stickedComment

stickedComment: IComment | null

ピン留めされたコメントを取得または設定します。

userInfo

userInfo: UserInfo

ユーザー情報を取得または設定します。

width

width: number | string

GcCommentの幅を取得または設定します。

静的 appendPopupsToBody

appendPopupsToBody: boolean

ポップアップをbody要素に追加するかどうかを取得または設定します。

メソッド

addCommand

addCommand<T>(name: T | string, command: CommandAction<ExecuteCommandOption[T]> | CommandAction<any>): void

GcCommentにカスタムコマンドを追加します。

Type parameters
- T: keyof ExecuteCommandOption
引数
- name: T | string
  
  カスタムコマンド名。参照 ExecuteCommandOption
- command: CommandAction<ExecuteCommandOption[T]> | CommandAction<any>
  コマンドが実行されたときに発生します。参照 CommandAction
```
gcComment.addCommand('SortByUpdateTime', ()=>{
      gcComment.sort({isDesc: true, sortBy: GC.InputMan.GcCommentSortBy.UpdateTime});
});
```
戻り値 void

addComment

addComment(comment: IComment): void

コメントを追加します。

引数
- comment: IComment
  GcCommentに追加されるコメントオブジェクト。参照 IComment
```
gcComment.addComment(comment);
```
戻り値 void

addEventListener

addEventListener<K>(evt: K | string, handler: GcCommentEventHandlerMap[K]): void

イベントにメソッドを追加します。

Type parameters
- K: keyof GcCommentEventHandlerMap
引数
- evt: K | string
  
  イベント名。参照 GcCommentEventHandlerMap
- handler: GcCommentEventHandlerMap[K]
  ハンドラー。参照 GcCommentEventHandlerMap
```
var onEditorCreated = () => {
     console.log('editor created');
};
gcComment.addEventListener(GC.InputMan.GcCommentEvent.EditorCreated, onEditorCreated);
```
戻り値 void

clear

clear(): void

読み込んだコメントをクリアします。
```
gcComment.clear();
```
戻り値 void

destroy

destroy(): void

現在のGcCommentインスタンスを破棄します。

戻り値 void

execCommand

execCommand<T>(name: T | string, commandOptions?: ExecuteCommandOption[T] | any): void

コマンドを実行します。

Type parameters
- T: keyof ExecuteCommandOption
引数
- name: T | string
  
  コマンド名。参照 ExecuteCommandOption
- オプション commandOptions: ExecuteCommandOption[T] | any
  コマンドパラメータの情報。参照 ExecuteCommandOption
```
gcComment.execCommand('SortByUpdateTime');
```
戻り値 void

getCommentElement

getCommentElement(id: string): HTMLElement | null

コメントIDによってHTMLElementを取得します。

引数
- id: string
戻り値 HTMLElement | null

getElement

getElement(): HTMLElement

元の要素を取得します。

戻り値 HTMLElement

元の要素
```
let element = gcComment.getElement();
```

getHost

getHost(): HTMLElement

GcCommentのhost要素を取得します。

戻り値 HTMLElement

hideSuggestions

hideSuggestions(): void

表示中の入力サジェストリストを非表示にします。

戻り値 void

reactToComment

reactToComment(commentId: string, reactChar: string): void

特定のコメントにリアクションを追加します。既に現在のユーザーによって追加されたリアクションがある場合はそのリアクションを解除します。

引数
- commentId: string
  
  リアクションが追加されるコメントのID
- reactChar: string
  追加されるリアクションキャラクター
```
gcComment.replyToComment('id_1', '👍');
```
戻り値 void

reload

reload(): void

コメントコンポーネントを再読み込みします。
```
gcComment.reload();
```
戻り値 void

removeComment

removeComment(commentId: string): void

指定したコメントを削除します。

引数
- commentId: string
  削除されるコメントID
```
gcComment.removeComment('id_1');
```
戻り値 void

removeEventListener

removeEventListener<K>(evt: K | string, handler: GcCommentEventHandlerMap[K]): void

イベントにメソッドを削除します。

Type parameters
- K: keyof GcCommentEventHandlerMap
引数
- evt: K | string
  
  イベント名。参照 GcCommentEventHandlerMap
- handler: GcCommentEventHandlerMap[K]
  ハンドラー。参照 GcCommentEventHandlerMap
```
gcComment.removeEventListener(GC.InputMan.GcCommentEvent.EditorCreated, onEditorCreated);
```
戻り値 void

replyToComment

replyToComment(commentId: string, reply: IComment): void

特定のコメントに返信を追加します。

引数
- commentId: string
  
  返信が追加されるコメントのID
- reply: IComment
  返信のコメントオブジェクト。参照 IComment
```
gcComment.replyToComment('id_1', comment);
```
戻り値 void

showSuggestions

showSuggestions(suggestions: string[]): void

入力サジェストリストを表示します。

引数
- suggestions: string[]
  
  候補項目の配列。各項目は文字列です。
戻り値 void

sort

sort(sortInfo: GcCommentSortInfo): void

読み込んだコメントをソートします。

引数
- sortInfo: GcCommentSortInfo
  ソート条件。参照 GcCommentSortInfo
```
gcComment.sort({isDesc: true, sortBy: GC.InputMan.GcCommentSortBy.UpdateTime});
```
戻り値 void

updateComment

updateComment(comment: IComment): void

指定したコメントを更新します。指定されたcomment.idがGcCommentに追加されていない場合は、発生しません

引数
- comment: IComment
  更新されるコメントオブジェクト。参照 IComment
```
gcComment.updateComment(comment);
```
戻り値 void

updatePopupsPosition

updatePopupsPosition(): void

ポップアップの表示位置を更新します。

戻り値 void

静的 getLanguage

getLanguage(): GcCommentLanguage

GcCommentの表示言語を所得します。

戻り値 GcCommentLanguage

GcCommentの現在の表示言語。参照 GcCommentLanguage
```
var lang = GC.InputMan.GcComment.getLanguage();
```

静的 setLanguage

setLanguage(lang: GcCommentLanguage): void

GcCommentの表示言語を設定します。（GcCommentが初期化される前に呼び出す必要があります）

引数
- lang: GcCommentLanguage
  GC.InputMan.GcCommentLanguage列挙型を設定します。参照 GcCommentLanguage
```
GC.InputMan.GcComment.setLanguage(GC.InputMan.GcCommentLanguage.JA);
```
戻り値 void

静的 setResource

setResource(lang: GcCommentLanguage, key: GcCommentResourceNames, res: string): void

指定された言語のリソースの値を設定します。

引数
- lang: GcCommentLanguage
  
  リソースの言語。参照 GcCommentEventHandlerMap
- key: GcCommentResourceNames
  
  リソースのキー。参照 GcCommentEventHandlerMap
- res: string
  リソースの値。参照 GcCommentEventHandlerMap
```
gcComment.setResource(GC.InputMan.GcCommentLanguage.EN, GC.InputMan.ResourceNames.PostAt, 'Post Time:');
```
戻り値 void

イベント

AfterExecuteCommand

AfterExecuteCommand: (args: ExecuteCommandArgs): void

GcCommentでコマンドが実行した後に発生します。

param: イベントデータ

型宣言

- (args: ExecuteCommandArgs): void
- 引数
  - args: ExecuteCommandArgs
  戻り値 void

AfterFirstLoad

AfterFirstLoad: (): void

GcCommentが初回コメントを読み込んだ後に発生します。

型宣言

- (): void
- 戻り値 void

BeforeExecuteCommand

BeforeExecuteCommand: (args: ExecuteCommandArgs): void

GcCommentでコマンドが実行する前に発生します。

param: イベントデータ

型宣言

- (args: ExecuteCommandArgs): void
- 引数
  - args: ExecuteCommandArgs
  戻り値 void

BeforeFirstLoad

BeforeFirstLoad: (): void

GcCommentが初回コメントを読み込む前に発生します。

型宣言

- (): void
- 戻り値 void

CreateEditor

CreateEditor: (args: CreateEditorArgs): ICommentEditor

commentEditorが作成される前に発生します。

param: イベントデータ

型宣言

- (args: CreateEditorArgs): ICommentEditor
- 引数
  - args: CreateEditorArgs
  戻り値 ICommentEditor

EditorCreated

EditorCreated: (args: EditorCreatedArgs): void

commentEditorが作成された後に発生します。

param: イベントデータ

型宣言

- (args: EditorCreatedArgs): void
- 引数
  - args: EditorCreatedArgs
  戻り値 void

PreprocessError

PreprocessError: (args: PreprocessErrorArgs): void

dataSourceのconfig設定とGcCommentのデータフェッチにエラーが発生するときに発生します。

param: イベントデータ

型宣言

- (args: PreprocessErrorArgs): void
- 引数
  - args: PreprocessErrorArgs
  戻り値 void

Inputman.GcComment

GcComment クラス

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

引数

el: HTMLElement

オプション config: GcCommentConfig

戻り値 GcComment

プロパティ

読み取り専用 activeEditor

comments

読み取り専用 displayComments

enabled

height

maxHeight

maxWidth

minHeight

minWidth

readOnly

stickedComment

userInfo

width

静的 appendPopupsToBody

メソッド

addCommand

Type parameters

T: keyof ExecuteCommandOption

引数

name: T | string

command: CommandAction<ExecuteCommandOption[T]> | CommandAction<any>

戻り値 void

addComment

引数

comment: IComment

戻り値 void

addEventListener

Type parameters

K: keyof GcCommentEventHandlerMap

引数

evt: K | string

handler: GcCommentEventHandlerMap[K]

戻り値 void

clear

戻り値 void

destroy

戻り値 void

execCommand

Type parameters

T: keyof ExecuteCommandOption

引数

name: T | string

オプション commandOptions: ExecuteCommandOption[T] | any

戻り値 void

getCommentElement

引数

id: string

戻り値 HTMLElement | null

getElement

戻り値 HTMLElement

getHost

戻り値 HTMLElement

hideSuggestions

戻り値 void

reactToComment

引数

commentId: string

reactChar: string

戻り値 void

reload

戻り値 void

removeComment

引数

commentId: string

戻り値 void

removeEventListener