| 1 | #LunarCalendar# |
| 2 | |
| 3 | 农历(阴历)万年历,是一款支持Node.js和浏览器端使用的全功能农历和公历日历类库。支持农历与公历之间相互转换,含有二十四节气,天干地支纪年纪月纪日,生肖属相,公历节假日及农历传统节假日信息等功能。自带2013-2014节假日安排数据,并可自行配置。带有黄历数据,可自行选择配置。支持1891-2100年。使用**LunarCalendar**可快速开发一款属于自己的万年历产品,行动起来吧! |
| 4 | |
| 5 | ##Install## |
| 6 | |
| 7 | 1. Node.js服务器端(使用npm安装): |
| 8 | `npm install lunar-calendar` |
| 9 | 2. 浏览器端使用,引用脚本: |
| 10 | `<script type="text/javascript" src="lib/LunarCalendar.min.js"></script>` |
| 11 | |
| 12 | |
| 13 | ##Usage## |
| 14 | ###Node.js### |
| 15 | var LunarCalendar = require("lunar-calendar"); |
| 16 | |
| 17 | ###浏览器### |
| 18 | `window.LunarCalendar`是一个全局对象,可以全局作用域直接调用。 |
| 19 | |
| 20 | ##方法列表## |
| 21 | ###LunarCalendar.calendar(year,month[,fill])### |
| 22 | 通过公历获取某月农历数据 |
| 23 | |
| 24 | ####参数说明#### |
| 25 | - @param {Number} `year` 公历年 范围[1891-2100] |
| 26 | - @param {Number} `month` 公历月 范围[1-12] |
| 27 | - @param {Boolean} `fill`(可选) 是否填充当月日历首尾日期,设为true时,会在首尾填入上下月数据,自动补全一个7*6阵列数据。(可更美观的打造你的万年历产品) |
| 28 | |
| 29 | ####返回数据#### |
| 30 | { |
| 31 | "firstDay": 5, //该月1号星期几(日历开始位置) |
| 32 | "monthDays": 28, //该月天数 |
| 33 | "monthData": [ //本月所有日历数据 |
| 34 | { |
| 35 | "year": 2014, //公历年 |
| 36 | "month": 2, //公历月 |
| 37 | "day": 1, //公历日 |
| 38 | "zodiac": "蛇", //生肖属相 |
| 39 | "GanZhiYear": "癸巳", //干支纪年 |
| 40 | "GanZhiMonth": "乙丑", //干支纪月 |
| 41 | "GanZhiDay": "癸卯", //干支纪日 |
| 42 | "worktime": 2, //0无特殊安排,1工作,2放假 |
| 43 | "lunarYear": 2014, //农历年 |
| 44 | "lunarMonth": 1, //农历月(1-13,有闰月情况,比如当前闰9月,10表示闰9月,11表示10月) |
| 45 | "lunarDay": 2, //农历日 |
| 46 | "lunarMonthName": "正月", //农历月中文名 |
| 47 | "lunarDayName": "初二", //农历日中文名 |
| 48 | "lunarLeapMonth": 9, //农历闰月所在月份,0表示无闰月 |
| 49 | "solarFestival": "", //公历节假日,undefined或‘劳动节’之类 |
| 50 | "lunarFestival": "", //农历节假日,undefined或‘除夕’之类 |
| 51 | "term": "" //二十四节气名,undefined或‘立春’之类 |
| 52 | }, |
| 53 | ... |
| 54 | ] |
| 55 | } |
| 56 | |
| 57 | ###LunarCalendar.solarCalendar(year,month[,fill])### |
| 58 | 获取公历某月日历数据(不带农历信息) |
| 59 | |
| 60 | ####参数说明#### |
| 61 | - @param {Number} `year` 公历年 范围[1-~]公元后 |
| 62 | - @param {Number} `month` 公历月 范围[1-12] |
| 63 | - @param {Boolean} `fill`(可选) 是否填充当月日历首尾日期,设为true时,会在首尾填入上下月数据,自动补全一个7*6阵列数据。(可更美观的打造你的万年历产品) |
| 64 | |
| 65 | ####返回数据#### |
| 66 | { |
| 67 | "firstDay": 5, //该月1号星期几(日历开始位置) |
| 68 | "monthDays": 28, //该月天数 |
| 69 | "monthData": [ //本月所有日历数据 |
| 70 | { |
| 71 | "year": 2014, //公历年 |
| 72 | "month": 2, //公历月 |
| 73 | "day": 1 //公历日 |
| 74 | }, |
| 75 | ... |
| 76 | ] |
| 77 | } |
| 78 | |
| 79 | ###LunarCalendar.solarToLunar(year,month,day)### |
| 80 | 将公历转换为农历 |
| 81 | |
| 82 | ####参数说明#### |
| 83 | - @param {Number} `year` 公历年 范围[1891-2100] |
| 84 | - @param {Number} `month` 公历月 范围[1-12] |
| 85 | - @param {Number} `day` 公历日 范围[1-31] |
| 86 | |
| 87 | ####返回数据#### |
| 88 | { |
| 89 | "zodiac": "蛇", //生肖属相 |
| 90 | "GanZhiYear": "癸巳", //干支纪年 |
| 91 | "GanZhiMonth": "乙丑", //干支纪月 |
| 92 | "GanZhiDay": "癸卯", //干支纪日 |
| 93 | "worktime": 2, //0无特殊安排,1工作,2放假 |
| 94 | "lunarYear": 2014, //农历年 |
| 95 | "lunarMonth": 1, //农历月(1-13,有闰月情况,比如当前闰9月,10表示闰9月,11表示10月) |
| 96 | "lunarDay": 2, //农历日 |
| 97 | "lunarMonthName": "正月", //农历月中文名 |
| 98 | "lunarDayName": "初二", //农历日中文名 |
| 99 | "lunarLeapMonth": 9, //农历闰月所在月份,0表示无闰月 |
| 100 | "solarFestival": "", //公历节假日,undefined或‘劳动节’之类 |
| 101 | "lunarFestival": "", //农历节假日,undefined或‘除夕’之类 |
| 102 | "term": "" //二十四节气名,undefined或‘立春’之类 |
| 103 | } |
| 104 | |
| 105 | ###LunarCalendar.lunarToSolar(year,month,day)### |
| 106 | 将农历转换为公历 |
| 107 | |
| 108 | ####参数说明#### |
| 109 | - @param {Number} `year` 农历年 范围[1891-2100] |
| 110 | - @param {Number} `month` 农历月 范围[1-13](有闰月情况,比如当前闰9月,10表示闰9月,11表示10月) |
| 111 | - @param {Number} `day` 农历日 范围[1-30] |
| 112 | |
| 113 | ####返回数据#### |
| 114 | { |
| 115 | "year": 2014, //公历年 |
| 116 | "month": 1, //公历月 |
| 117 | "day": 31 //公历日 |
| 118 | } |
| 119 | |
| 120 | ###LunarCalendar.setWorktime(data)### |
| 121 | 设置某年的节假日安排信息(类库已内置2013-2014年的数据) |
| 122 | |
| 123 | ####参数说明#### |
| 124 | - @param {Object} `data` 节假日安排信息(以年为key,可设置多年) |
| 125 | - 0:无特殊安排,1:工作,2:放假 |
| 126 | |
| 127 | **参数data格式如下:** |
| 128 | |
| 129 | { |
| 130 | "y2014": { |
| 131 | "d0101": 2, |
| 132 | "d0126": 1, |
| 133 | "d0131": 2, |
| 134 | "d0201": 2, |
| 135 | "d0202": 2, |
| 136 | "d0203": 2, |
| 137 | "d0204": 2, |
| 138 | "d0205": 2, |
| 139 | "d0206": 2, |
| 140 | "d0208": 1, |
| 141 | "d0405": 2, |
| 142 | "d0407": 2, |
| 143 | "d0501": 2, |
| 144 | "d0502": 2, |
| 145 | "d0503": 2, |
| 146 | "d0504": 1, |
| 147 | "d0602": 2, |
| 148 | "d0908": 2, |
| 149 | "d0928": 1, |
| 150 | "d1001": 2, |
| 151 | "d1002": 2, |
| 152 | "d1003": 2, |
| 153 | "d1004": 2, |
| 154 | "d1005": 2, |
| 155 | "d1006": 2, |
| 156 | "d1007": 2, |
| 157 | "d1011": 1 |
| 158 | } |
| 159 | } |
| 160 | |
| 161 | ##黄历数据## |
| 162 | 在目录/hl/下有2008-2020年的黄历数据,用户可自行选择在自己万年历中进行添加。 |
| 163 | |
| 164 | ##公用服务器API## |
| 165 | 用Node.js搭载lunar-calendar类库。 |
| 166 | |
| 167 | - API:http://api.tuijs.com/ |
| 168 | - 请求类型:GET |
| 169 | - 返回数据:JSON 或 JSONP |
| 170 | - JSONP:支持,添加参数callback(仅支持数字,字母,下划线) |
| 171 | |
| 172 | ###API列表### |
| 173 | |
| 174 | - 通过公历获取某月农历数据 http://api.tuijs.com/calendar |
| 175 | - 获取公历某月日历数据(不带农历信息)http://api.tuijs.com/solarCalendar |
| 176 | - 将公历转换为农历http://api.tuijs.com/solarToLunar |
| 177 | - 将农历转换为公历http://api.tuijs.com/lunarToSolar |
| 178 | |
| 179 | **例如:** |
| 180 | |
| 181 | http://api.tuijs.com/lunarToSolar?year=2011&month=1&fill=1&callback=fn |
| 182 | |
| 183 | 返回: |
| 184 | `fn({"year":2011,"month":2,"day":16})` |
| 185 | |
| 186 | ##其它## |
| 187 | - 项目主页:[http://www.tuijs.com/](http://www.tuijs.com/ "项目主页") |
| 188 | - 作者博客:[http://www.2fz1.com/](http://www.2fz1.com/ "作者博客") |
| 189 | |
| 190 | JasonZhou |