[]
デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Index

InputMan Namespace

型の別名

変数

クラス

インターフェイス

列挙型

メソッド

型の別名

CommandAction

CommandAction<T>: (gcComment: GcComment, options: T): void | Promise<any>

コマンドアクションを定義します

型パラメーター

  • T

型宣言

    • (gcComment: GcComment, options: T): void | Promise<any>

    • 引数

      戻り値 void | Promise < any >

CommandOptions

CommandOptions<T>: T extends keyof ExecuteCommandOption ? ExecuteCommandOption[T] : any

コマンドオプションを定義します

型パラメーター

  • T: string

CommentFormatter

CommentFormatter: (content: string | HTMLElement): HTMLElement

コメントを書式設定する関数の型を定義します

param

書式設定のコンテンツ。 プレーンな文字列か HTMLElement を設定できます

returns

書式設定されたHTMLElementコンテンツ

const formatter = (content) => {
  if (typeof content === 'string') {
    const span = document.createElement('span');
    const processedContent = processContent(content);
    span.textContent = processedContent;
    return span;
  } else {
    return content;
  }
};

型宣言

    • (content: string | HTMLElement): HTMLElement

    • 引数

      • content: string | HTMLElement

      戻り値 HTMLElement

DateFormatter

DateFormatter: (date: Date): string

日付を書式設定する関数の型を定義します

param

書式設定する Date オブジェクト

returns

書式設定された日付の文字列

const dateFormatter = (date) => {
  return date.toLocaleDateString();
};

型宣言

    • (date: Date): string

    • 引数

      • date: Date

      戻り値 string

EditorConfig

EditorConfig: GcMultiLineCommentEditorConfig | GcRichTextEditorCommentEditorConfig | CommonCommentEditorConfig | CustomCommentEditorConfig

コメントエディタ設定を定義します

ExecuteCommandOption

ExecuteCommandOption: { [GcCommentCommand.AddCommentElement]: AddCommentCommandOption; [GcCommentCommand.AddReplyCommentElement]: AddReplyCommentElementCommandOption; [GcCommentCommand.ChangeUserInfo]: ChangeUserInfoCommandOption; [GcCommentCommand.DeleteCommentElement]: DeleteCommentElementCommandOption; [GcCommentCommand.DeleteComment]: DeleteCommentCommandOption; [GcCommentCommand.DoDeleteCommentAction]: DoDeleteCommentActionCommandOption; [GcCommentCommand.DoEditCommentAction]: DoEditCommentActionCommandOption; [GcCommentCommand.DoReplyCommentAction]: DoReplyCommentActionCommandOption; [GcCommentCommand.GotoComment]: GotoCommentCommandOption; [GcCommentCommand.Load]: LoadCommandOption; [GcCommentCommand.OpenReactionPopup]: OpenReactionPopupCommandOption; [GcCommentCommand.PostComment]: PostCommentCommandOption; [GcCommentCommand.ReactToComment]: ReactToCommentCommandOption; [GcCommentCommand.ReplyToComment]: ReplyToCommentCommandOption; [GcCommentCommand.Search]: SearchCommandOption; [GcCommentCommand.SetComments]: SetCommentsCommandOption; [GcCommentCommand.Sort]: SortCommandOption; [GcCommentCommand.UpdateCommentElement]: UpdateCommentElementCommandOption; [GcCommentCommand.UpdateComment]: UpdateCommentCommandOption }

GcCommentCommand型と対応するコマンドオプションをマッピングします オブジェクトの各キーは特定のコマンドを表し、その値にはマッピングしたコマンドに必要なオプションが設定されます。参照 GcCommentCommand

型宣言

FormatFunction

FormatFunction: (v: number): string

書式を定義します。

型宣言

    • (v: number): string

    • 引数

      • v: number

      戻り値 string

GcCommentConfig

GcCommentConfig: GcCommentChatModeConfig | GcCommentThreadModeConfig | GcCommentListModeConfig | GcCommentConfigBase

GcComment設定を定義します

GcCommentThreadModeConfig

GcCommentThreadModeConfig: GcCommentThreadModeLoadRepliesOnDemandConfig | GcCommentThreadModeLoadRepliesNotOnDemandConfig

GcCommentスレッドモード設定を定義します

HeaderFooterItem

HeaderFooterItem: string | GcCommentHeaderFooterItem | (string | GcCommentHeaderFooterItem | HeaderFooterItemConfig)[]

HeaderFooterItem型を定義します

ICommentContextToolbarItem

ICommentContextToolbarItem: ICustomContextToolbarItem & ICommonContextToolbarItem

コメントのコンテキストツールバー項目を定義します

ICommentEditor

ICommentEditor: { destroy: (): void ; getContent: (): string ; getEditor: (): any ; getIsDirty: (): boolean ; setContent: (v: string): void }

コメントエディターを定義します

型宣言

  • destroy: (): void

    エディタを削除します

      • (): void

      • 戻り値 void

  • getContent: (): string

    コメントエディタのコンテンツを取得します

    returns

    エディタのコンテンツ

      • (): string

      • 戻り値 string

  • getEditor: (): any

    コメントエディターのインスタンスを取得します

    returns

    コメントエディターのインスタンス

      • (): any

      • 戻り値 any

  • getIsDirty: (): boolean

    コメントが編集されたかどうかを取得します

    returns

    コメントが編集された場合はtrue、そうでない場合はfalse

      • (): boolean

      • 戻り値 boolean

  • setContent: (v: string): void

    コメントエディタにコンテンツを設定します

    param

    新しいコメント

      • (v: string): void

      • 引数

        • v: string

        戻り値 void

ICommentEditorCreator

ICommentEditorCreator: (gccomment: GcComment, context: ActiveCommentEditorContext): ICommentEditor

コメントエディターの作成を定義します

型宣言

LoadUsersCallback

LoadUsersCallback: (context: LoadUserContext): Array<UserInfo>

ユーザー情報を読み込む関数を定義します

param

ユーザー情報を読み込むために必要な詳細を含むコンテキストオブジェクト。参照 LoadUserContext

returns

UserInfoオブジェクトの配列。参照 UserInfo

const loadUsersCallback = (context) => {
  return [
    { id: 1, name: "User A" },
    { id: 2, name: "User B" }
  ];
};

型宣言

ReplyLevel

ReplyLevel: number

返信レベルを定義します

RequestMethod

RequestMethod: "Get" | "Post" | "Put" | "Delete"

GcCommentのdataSourceでサポートされているリクエストメソッドを定義します

変数

LicenseKey

LicenseKey: string

開発用または配布用ライセンスキーのいずれかを設定します。 ライセンスキーを設定しない場合、localhostや127.0.0.1のローカルアドレス上でトライアル版として動作します。 開発用または配布用ライセンスキーのいずれかを設定します。 ライセンスキーを設定しない場合、localhostや127.0.0.1のローカルアドレス上でトライアル版として動作します。 開発用または配布用ライセンスキーのいずれかを設定します。 ライセンスキーを設定しない場合、localhostや127.0.0.1のローカルアドレス上でトライアル版として動作します。

appearanceStyle

appearanceStyle: AppearanceStyle

InputManJSコントロールのデザインを設定します。

すべてのコントロールを初期化する前に設定する必要があります。デフォルト値はclassicです。 初期化以降のデザイン変更ができません。

GC.InputMan.appearanceStyle = GC.InputMan.AppearanceStyle.Modern;
param

AppearanceStyle

メソッド

FindIMControl

  • ページに配置されたInputManのコントロールを表すJavaScriptオブジェクトへの参照を取得します。

    引数

    • el: string | Element | Element[]

      ID、セレクタ、HTML要素、またはHTML要素の配列を指定できます（HTML要素の配列の最初の要素が取得されます。）

    戻り値 GcInputManBase

    コントロールを表すオブジェクト。

getLanguage

  • 現在のGcRichTextEditorの表示言語を取得します

    var displayLanguage = GC.InputMan.GcRichTextEditor.getLanguage();

    戻り値 GcRichTextEditorLanguage

setLanguage

  • 現在のGcRichTextEditorの表示言語を設定します GcRichTextEditorインスタンスを作成する前に言語を設定する必要があります

    GC.InputMan.GcRichTextEditor.setLanguage(GC.InputMan.GcRichTextEditorLanguage.EN);

    引数

    戻り値 GcRichTextEditorLanguage

updateCustomEra

  • updateCustomEra(customEras: Array<ICustomEra>): void

  • 年号をカスタマイズします。

    下記サンプルコードです。

    var customEraExample = [];
customEraExample.push({name: "明治", abbreviation: "明", symbol: "M", startDate: "1868/09/08", shortcuts: "1,M",});
customEraExample.push({name: "大正", abbreviation: "大", symbol: "T", startDate: "1912/07/30", shortcuts: "2,T",});
customEraExample.push({name: "昭和", abbreviation: "昭", symbol: "S", startDate: "1926/12/25", shortcuts: "3,S",});
customEraExample.push({name: "平成", abbreviation: "平", symbol: "H", startDate: "1989/01/08", shortcuts: "4,H",});
customEraExample.push({name: "令和", abbreviation: "令", symbol: "R", startDate: "2019/05/01", shortcuts: "5,R",});

GC.InputMan.updateCustomEra(customEraExample);

    引数

    戻り値 void