Kothic JS 技术文档

1. 安装指南

首先，您需要在您的系统上安装 Node.js。安装完成后，使用以下命令安装 Kothic JS：

npm install
npm install -g grunt-cli
grunt

执行上述命令后，压缩后的 Kothic 源码将会生成在 dist 文件夹中。

2. 项目的使用说明

将 dist 文件夹中的 kothic.js 文件包含到您的网页中。之后，您可以调用以下方法来渲染地图：

Kothic.render(
    canvas, // canvas 元素（或其 ID）用于渲染
    data, // 要渲染的 JSON 数据
    zoom, // 缩放级别
    {
        onRenderComplete: callback, // （可选）渲染完成时调用的回调函数
        styles: ['osmosnimki-maps', 'surface'], // （可选）只渲染指定的样式，如果没有指定则渲染所有样式
        locales: ['be', 'ru', 'en'] // （可选）地图语言，具体见下文
    }
);

locales Kothic-JS 支持基于 name:*lang* 标签的地图本地化。渲染器将按照提及的语言顺序进行检查。如果对象没有本地化名称，则使用 *name* 标签。

3. 项目API使用文档

Kothic.render 方法是该项目的主要API，它接受以下参数：

• canvas: 用于渲染的 canvas 元素或其 ID。
• data: 要渲染的 JSON 数据。
• zoom: 缩放级别。
• options: 一个包含以下选项的对象：
  • onRenderComplete: 渲染完成时调用的回调函数（可选）。
  • styles: 要渲染的样式列表（可选）。
  • locales: 地图语言列表（可选）。

4. 项目安装方式

项目的安装方式与安装指南中描述的步骤相同。首先确保 Node.js 已安装，然后执行以下命令：

npm install
npm install -g grunt-cli
grunt

这样，您就可以在 dist 文件夹中找到 Kothic JS 的压缩源码，并将其用于您的项目中。