Hook APIs

Hook 机制类似插件设计，可以通过特定 APIs 对程序流程进行自定义控制。

例如，实现自定义的数值格式化：

render(dom, {
  // ...
  hook: {
    formatDataNumberValue(value) {
      if (typeof value === 'undefined' || Number.isNaN(+value) || Math.abs(value) === Infinity) {
        return {
          value: '',
          unit: '--'
        };
      }

      return F10Utils.getFormatYAxis(value);
    }
  }
});

hook

范式组件

beforeRenderStandardChart

• (api: ExtensionApi, renderParams: RenderParams) => void

渲染范式组件前对配置项进行预处理。（RenderParams 请查看范式组件 play() API 文档）

时间轴组件

beforeRenderTimeline

• (api: ExtensionApi, renderParams: RenderParams) => void

渲染时间轴组件前对配置项进行预处理。（RenderParams 请查看时间轴组件 config 配置文档）

其它

globalConfig

• () => Config

  type Config = {
    /**
     * 行情图组件鉴权信息
     *
     * @see https://khtest.10jqka.com.cn/kodexplorer/data/User/wangyifan/home/HXKlineChart/docs/guide/encryption.html
     */
    hxKLineVerifyInfo: unknown;
  }

设置配置信息。

parseDataMetaInfo

• (data: Specification['data'][number]) => DataMetaInfo

  type DataMetaInfo = {
    /** 字段名称 */
    [fieldName: string]: {
      /** 字段文本单位 */
      unit: string;
    };
  }

实现数据集元信息的解析。

formatDataNumberValue

• (value: number) => { value: number; unit: string }

实现数值的格式化。