@mapgis/webclient-common
Version:
An important part of the MapGIS Client for JavaScript product, which provides interfaces and functions unrelated to the map engine.
6,015 lines • 102 kB
HTML
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no" name="viewport">
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<title> MapGIS Client for JavaScript API </title>
<script type="text/javascript">
</script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<script src="scripts/jquery.min.js"></script>
<script src="scripts/adminlte/app.min.js"></script>
<link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="styles/adminlte/AdminLTE.min.css">
<link type="text/css" rel="stylesheet" href="styles/adminlte/skin-blue.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/common.css">
<link type="text/css" rel="stylesheet" href="styles/header.css">
<link type="text/css" rel="stylesheet" href="styles/examples.css">
<link type="text/css" rel="stylesheet" href="styles/style.customize.css">
<link type="text/css" rel="stylesheet" href="styles/font-awesome.css">
<link type="text/css" rel="stylesheet" href="styles/jaguar.css">
<script src="scripts/bootstrap.min.js"></script>
</head>
<body class='sidebar-mini'>
<div id="wrap" class="clearfix">
<header class="header-wrapper main-header mapgis-header">
<nav class="navbar navbar-static-top lite">
<div class="nav-header">
<div class="navbar-header">
<div class="navbar-title" style="display: flex;align-items: center; ">
<a href="index.html">
<img class="mapgis-webclient-logo" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKAAAACgCAYAAACLz2ctAAAACXBIWXMAAAsSAAALEgHS3X78AAAgAElEQVR42u2de3gb5Z3vv+/Yjp2rFF8Sx5atsRMgpbRWC7Q9tF2rfbYtpZQYKBRoS4aWpeFWD3DKluW0Hvd2oGnppKHAlpsMIaSwgF3ucHaR95xuT7cPi10O5ZLYluI4duxcJDuJE8ea3/ljXlmyLMm6jG72/J5nHtuSZjwz72d+9/cVIyKYYkquRDBvgSkmgKaYAJpiigmgKSaApphiAlhAYnt94grba+NW806kJsxMw6QmtS/7RDDmYkWCCCIrESlDX7Ko5p0xAcyo1Lxw2ArGFCawVjAGViR4QWQnIkAjL4ikoQtWu807ZQJoPHx/OChDEBQwZmECQxQAASKQRl0gkvd/tcJj3jUTwLRl3XOjTgjMxRizQxB08OIDGPzZDtLU4ZY1PvMumgAmLdX/MiJCYCpjbBMEBsYYkgQQIM1PGskjl6x1mXfUBDAhWfvUfitjTAZjbSHwUgYw+Hc3NFJGLltn+ocmgHHg2zUkca1nwSzw0gYQ0AhE1AGN5ANX1JpmGWYecEbWPLHXuWbnvh4AjwKwZPBfbQbgWbNzUDHvuqkBUfWYR+Rplc1ggq7ZgtouMxpQ/6lpAJGXNJLGvmV3mwAuMql8tF/38wQmh9IqWQdwxj8kjaSDUsOiS9ssShNc+XCfBKAHQFuGzW2i0gxgoPKRfrXy4T1WE8AFKhW/+8BZ8dAeN/fz7Hl4iq0APBUP7pZME7yApPz+96w8st0MQYgwqSzMpObMBOs/Z3++lzSSD285Y0H7hwteA5bf964CwMOjz0KSJgBvlN//nqv8t++KJoAFJqu3v9Oy+t6/efLIz0snbdOz+t6/Lci0zYIzwVb1rw4wQWUCaw43leEmtEBMcJT9NC8Ryb7Wj3SaAOaZWH7VY2WMKRBY6wxICw/A4P7dRCT7b23qMU1wPsC39S2Z+3mtiyR4bAbwluWXPapl61tWE8Acyaq73nSu+sV/eQD8usD9vLTSNqvuflM2TXAWZeXP/lPU+/OE5rkmMsyUZt4EdzCByQAkIlKgkSVLJhizTb4GaNRLRPLEP53rNgHMkKz48f8Nls94m5SAHAHYzQQmD33ZOuOD1b7qt0IjFUSbcwRg8LUuIpKP/vCTHhNAI+FT/hRqk5qBJOsA+iEI8v4Ly12xzrP2pSNO0kFsyhGAICI/NE0lIvWYcp7PBDANWf7DPzo5eE2zoMk+gO2MMXX/RZUJDWjN84dk0kgBaZYcABj8rBcaKcd+/GmXCWCSsuyf/p23wwubokKWPQC7GWPS8MVrkjZp67oOWkGaQhq15gjA4Ge6SSP5+M8+22MCOI8s/Ue3lektUjIEZokJWeYB9IIxaeRr1Wk79dXPHnCASIVGzTkCMHisDtJInryr2WcCGA2+29+QeHOoPQRN1gH0Q2DqgctrFKOvr/rpYYl0EC05AhCkkR+kKZN3f041AeRSdtu/Ojl4UcpnWQWwgwlMOXBFbcYiyLVP7bdCI4U0rTVHAAKkARp1T279vDPXY1+cy39eKr9mBWMqE4Rcd6r0ApBHr7JlPId24PIaHwB5zc5BFYCLVzWyKX4AKt8WrwYs/d6rSqgdPqK+mj0N6IfAlLGrxZwNRtXj3hYQqaSRPUs+oDJ5V3Pe5AizDuCSG19u4WkVe8j85QTAbYwxZUxqyLlDXvWYx0oaydCoLYNRsHL8Z5/NuypJ1gAs2fKig4PXPNf/yiqA3Ywx+eB31uddSqLykX4RpLlIo2aDAPRDI3lR5wGL/+EPVghMYUxojQ5L1gD0MsaUQ9ednreDEZSKB3c7QeQijexpANi+6Cshxdd2ydB79GLn87IDYDsEph7+7hkFtRpB+QPvKyCSoZEl32rBttcnrAAc+76w0p13ABZJz+mrSSWSz8ssgN1MYNLhGz7kQYFK+f3vidBIJaJN+dINY3ttXAagAFD3fXFVWvlSQ9Mwwree4W1SrDnH4+YFIB256Uw3ClwOX7/RA6Bl9b1/c/K0jT1KWkUZv+OcjEfytS/7nNrJU48JpSV1eZUHZFc9ZWUCU8CEXHck+wGovtazFCww4Q+TaN32dlD7WABsA6CM/+PZGXUtal44LAaOnXigaHnZl1hxESigAQDoVODDOfcB7T/+D3nw/aEfg2ElIk1iIqbUOBPcwRiTfbc2ZcXPs70+4QAQ3g7fs+8LK7Pyv62//quViKz+W5sy7lqs/f1+lZUU38CKhJLI96bHj/nHvmW35lQDbjx3g3XpirKVe3oHTmoaSnOgHHoByP7bHO4MQCYCcAIQ+Qb+04EoUwBsr08Ef+0G4IO+/Ic7XUc9Uny3fNTHj5+53OTj3guFJcU7WEmxBSBQIDDnM0Q0nXMTTATUb7ShprG6tO+v3pODfcPZgtAPQB6//eOGplVsr020hEHn4RC59n1xpcf22oQzzPzFk6APvAlAm+21CQDoAuDmx8rbaLz66WFRO3nqlaKyJWcAALi5jWo+BeFozk3wF18YUaBP/gYATB47iXf+c/cJ/5GjZRk0wdsgMGXijnN9xkA3bgUgc/BcYZrOyrUd+O9NBo1zhw7iqrwJktbuGrIGjk6qRSuWJlyX16ZOeceuFsWca8BwKVtWirOdZ5WNDR/GB72eE1NT02UG3qduAPLEnZ8wpIphe3Vc5BpN5OB18r8ztXCRl0NuBSDbXh13AVD2fWmVK5fwVbkGbgBjdwtLS1dQHI03Z+wD6afw0o+CY2jQqurVqKpeXTbw/hD2DhyYIg1L0hw4+eiPPmXIigC2V2Y0Xhs/tgt6d0g6Uzv9HF4Ph0ziflonN709+85fFR40SLZXxkUALtsr4zIAed/52dWIVY95HNrJU51CaYldByqQ3AE0Le1zSNsE/33X/lkmOJpMnwpg998Gp0ZHfEtSMMHtEJh6rN2YklLdK+PSPLB5OTAerhk3zxMANXGTKg+ev8qX4jkF72EXACnV4yQqla5+q3Zi6nGhbMmFaeme6YD30LWn5dYEQ5sf4OIiAR/6iH3JOlsFPHtGToxPTCZilrsAyMd+8mlDUg11L/utXNNtigFdJwDX4JctPRH7tXBN5okIMm4Z/LIxX801eP4qpe5lfw8/P0/dy/6WwS9bMqINy+97d6tQUiwLJcXFCGgZH/ss+ICJn4TFuhxN56wvOzByBN7+0RNT04GyGDBIx3/+d4YNQN1LfgcHzB7tfw1eEGewCQqAzsELLBnLudW95Fe4yVb5zzfqXvJvG7zAYtiKBxW/+8AJwnZWXHQWEQEG+G+k5bEPGDfiWmtFRcXKsv1Dh7Fv6PAUAUuCPtTk3U7V4MGNZXJ1s3mBJa65G7wgK19AKPGHo40HWlYArfzBaZnvHONrvPes/PqN7zqnfNCAKT4FRYKAurpKrFljWbJ7z4Hfjx89sWXyF58z1Pepe9EvQV+ON1KuGfyKJaeRZ4SWVaGvbxM07+Gm3l33ot85+JXkIeRrCsrI43VzinP9FJQuKcaoct4Vhpu1F3zR4OsGIA9eaM2vZlSizjBNGJlrbALgrnvB5xy80JoQhNZtbzsRvXHBYGF5AKCWfxPbI+DzA2gB0JPoAGZbBi+0egCodS/4XNxXDUaW9mQgtNzTK3JzuykrJ87yAMB8m9he/7yvhc3WfOrer1rdKADhcDnrn/e5oOcS/WHms4mnhxwxDxDQHHHfN1qK0l/dL/0jEKW/GQXfH3wOEFwgAIQOEDr2ftWqoNCEoIBgB6ETBD+/HoDQVP8HX0zf1f/9j3VSQHNQQGungIZMb0ZE0mkDSBqlvRkCX9cRK4hcILKA6Jq9F1klEMn1XUcKDsC9F1k9IOoFUQuI1IgHdnN915GWWPuO/+Bs3/gPzlYoEGigQKCbAgFkbNMCpgYME4WbqW17N6121XcdCS7bG7VKY3t9osX2+oTb9vqEy/b6RD5C6ubmV4SerwwXV33XETHezhN3fsIzcecnnBTQLqaA5s2IFiy0RHTG/L7OI06E1ofuqe884glz4HujmGqnADwXkfZQOJgij0Y9+76w0pWj63GEXc9mALeEpWnAwQz6iXGF1887l7f9h+EpGVaUByYYwTVN0tnS95lcQZ8PBDnMZwJobuOmMDHVKUxMIXybuanTJLFpamPT5MzZE0WwRlyDJ+JvgNBc/9wRKdFDHms/T0FAcyCgdSGgwYiNDGhGKHgNWP/cYQUA9l5cLkW8HtSCnjnB2/gpiWsPJ0LNBDqAJ6aDUaQnB9ci8yjWh1CjA/hrHZhbzVAQ6l+cH8KffsYDoGXZHd1Onq5Jq7+RaUV5kAfMIYD1zx4OtlXJEa+rYSZ4c/2zh0UA8t5LynsAoO/62k6eb5trEiYDjjAfLNuaT+JQ+MPAauIAuqMAaK9/9rC095LypFyF4/+z2Q3AYb2nl6ZGfSlrMiN8wIKOghlBZgRf5AAwmrM1M8Jb9mcOu+3PHI5pWhsfHrYKk9N2YXIawuR01qsljOBkhG2MYGGEVkboZATv3kvKW/i1Rru2lGvVxatXYumGWhStXJZiGkbLPYC5jYJJAihKBEsqojhNADUD9Ib9mUNRfSc2GbCyyUAvmwyAhTRh1sR7abkPIE/Y+bYB5LY/c8gJkD3GNVliXU8iY8cEhrLaSixrrIFQtiQ5CGkRa0D7vxySQLB6L61wzR3ICg8I3SBsA+GWKOMWdSph3002T99NNocwOd2QCw3Iz13lwVTwXJ08MY04m5Lu2LHSEixtWIfSmkr9vYQgLNB2LIP8pZZ4Drj3axUzptb+9CEfQuW5bu9lFXHN1u7vix7kULxfq5DsTx+yQq/p2jF/U4Hd/vQhh/eyip50x65k9QoUr1qGqeFDmBqbp3RuQCK6IKNg+9OHRD44DQkN6GUVrmSixTwRF5JrKpAig7FUlQcTGEprK1FSZcGkZwSBo5MZG/vCzAMSOUHU672sIilNZX/qoGp/6qA1xnstsd7LjYYnX5K+dNJ5y/lcI1ZcjGUbbFgqrgMrKspIJUQwQgOmu6Vgfp2gFDSavp8zxnsuUA5SL7HPNdmtyf77g2ImAshiy3Is/1A9lqwtn+UfGjErTsjBjZq7JS8tKebpfIjdrqQAaLL//mC+mGqJ5wOTEWcmANSjZQFlNRVYcaaI4lXLDQtC8iEN05uUGd110AGCz/v1yp4UH5aog+T9emUw+txs33Wwx77roGzfddCRC/Lsuw6KIGxO4WFOCsDA1KkTyVortqQYy06rxfKNdRCKhRO5D0LS9wOS6lJmRGKK2g9MN/eOOO/L0CcEebhGtIhPjnkRKsv5PFdWtWQKPPHJMSsAmYWCiWQbB5J6YOjkqRMoKkpp5YriFctAU4GRxZiGcSD1MlkPgGbxyTHRc2XVnADGc2WVj5t3iE+Oufj/mZUGEZ8cUzxXVilJQuXwXFnlnuczLn5t6czjSK62S+mO32JMRBNEEHpSvF++REyVuHPMyrtqLFHMXJu4cywhTSPuHHOA0ANCZ9x99ETzpihdMMHO7t5EzbC4c0zM3tgh9wBmvRRHED1XVaUKYLBdPyYM4hNjCm9/iueDdYpPjMVN2YhPjEkguHlrvQUEd8x9QseNBrwIgpqEH5h4JKxpZemN26JMw6R+0Z5vVHkA6gbIMReYUaf4xKiH118t84yyHaDO2PCNKgA9GnEcC0A94hOjapTzkgHqiPG/RM83qlwAeY1OK1C6AC7KRDTBIe4YdYk7Rh0pakEFhGZxx6gIAOKOUVHcMeoG4Q2urRId52Zxx2yYxB2jVnHHaCcIbTH2sYPQKu4YleZCuEaKYWrt4o5RKYF6cPJpLUpXgWARakDdTG0GwS0+Ppp05cLzzTVu3qigio+PKiAMgNCcYg5TmnUOuonflMB+coxr64zx+RbPN9e4EvYFk3Gf0lEctAibEVjo/1l4qkRO4Rgq9Dkh6U7gtiC0qBAYUaIPRFPDYwecPOp1DVy91sf398VLMMd5Py3lkcuxL8R2rPDqQEpfCzFw9dpO6C3u7XzblsYtCH8Akvl+FCff193w2AFrw2MHJMyeeDQLdP6+B8YSmPPZjIWXB9RTMMGB9qZ6mIGr1874YQ0dB9xpnJG9oeOAhBgt/vPtixjzVqLIoxm4l+lNCluUzQiRs8XSlAbXAWcaPuCMLxi2ioE34XQJ4Zqw9Eu0FEwvb6rNSG097bHDomzHop7wFIUBakAxoKOimW9qEvts5tfSHuN9L0BO/RqTOpeeJAhMc1ucUbAvPEXR8OhIyhA2PDpihPabVSVJMJXTzrWba0CqVqJoTT8ILQNStS8sMt4WEQV3gPA5PuWgO/j6gFTtSwrAHEfBhZgH7EmnA2QGvkdGHHHSHpneWvjW0/DIiItXTMLhcw5cU90TrPxwYDv57zPux8A11e6Ba6rVsP17k1MeyH4vZ+FXQubUgZ0pwRdaeyUX0gRAGfh2dTB4Ce+wUQe+rcPX8MhIcN6zG8AbEefb1vDISPDmBX1hN5InsLBNcLZrwQPfrvYwIi8jAt+SArDx4WEHI3IzIkvYMXKxbW58eFge+HZ1JyOSwl5vCc9Xhp1nd5RjdDc+POxkRE7+tztZc5Ke4lis0zJnm05740PDCSWAGx8atvJ9LTkyvZHbrxsfGnb0f2ddJwhdwdb6xoeGfY0PDbvDGiJcMXzVZl5CDH4uOQDzYF2fQp2YHnmjE60Ly8j4usnJX0vjQ8NShGthiUhq2+Mk5bv47739167zJfkgF34iOieLE8190p0J+T+p9hFmViw8yewFcDH0DnEn9wvjNZj28s9I0EuKrpT89zS0WH58T0gOFinv/4d1vsbf7e9CqJYrJnjH3chfsSO0ZuF80t5/XY0CAI2/2y+mFICEW6+0SimL0wQj4olPyAT3X1cTXPasUKUXwMeC8IVp/97+62p6sj92eZGIzg1//dfVdIYlcJsa/3m/M8GH1pMnAUiyW2//dTWOcNAa/3m/lSe+1VT1V8HnAaFp6W+pW4DwVnU1wX16ChG+qAl3faK9t/+7Na6caI/8aMnPZVcPucJa1ZsaHxhSEthHDBvZboBW85/5Sl8vQM7+LTVRIlxqib48XbbSMFjcGrB/S62PEZSwxRrl9fcPxQxI1t8/5GSEzfyzvf1bap38GO4Yiz/mevMzQkv/llpflGtpYQSxf0utK3UDshAS0Tn+loa+62vDW9UtcU3x7HkVTevvG7Ly1x15qPz8IDj7rq/1zIHvviErT04r6SkPmIloYxKaJIWN3Kb19+1rieN2Y247V9ItT5ne/AA5+26o7Ynjerj7bqh1pzt26fUD5kUUTDmPpPpusPXwjpGZgGT9b/fNKs+t/+0+axRN5+NcNuVZwCH23WCLCt/63+6TePAhGZHRN6dlauQxIkHWd6NNCTPF9jkzz3T4ImvAnevv3SflmelV+m60RS2prb93X3CSekuszyRdycgxgPlQijMEwJm0hH48C4C29dv3dfbdbAv21UVrWGhCJuZapCezzOr67fskhOabdAJQ+262GVLRoekAKI1vvMyLecF58U1JQS14s83H29j9XJ241m8fdEbxE/M25aJfA7B++6Bz/fZBD19hQeVbT9/NNsXAB9bUgEZL3811PRt+MyhzzdYE4I0Nvxk04Lu9s6P9Nvxm0AFAZbO7YTbzMpzT0P9GaSoAMqPgqLLne3WusBlnhbS1gvBWlN6/XhCce75XZ9jEdHb1s9Z0S3H5UQvOk+8LngNha50LenuTH4UtXQCce1rrDF0VoaxuzfnCkpJsL61svAlOV4NNV1dkbBncPa11nRvUvU7kdv5HOtKxR66XMnHg5RtqbYGjxzHx//rTGPo8WKQ8HRWuLSvD1FmNNttr42LGIJTre3jerLfAzPEtmYBv7VP7rdVPD7uKVy3dWlpbidXnfQQllpW8KpLkVqhRMBUV0dRZjTh20WcwXWE5mzTqqX3Fp9S+7MvI93TsuaW+hzvw2wpA6/UC+NieW+pVw+HbNSQD8BCCc0gIRSuXwvrfzsSqs0+HUFoMkJbEVoBR8PT6WkydvZFRSXHIkSWygNAGkFTz4mF5/1fKOzMAoQ+AvOGevZ3Qm1nteQhfOwB1z631hvp7a3YOOsGYizGmT5oPqi4Wyg2UVpdjSaUFx/v34/ieIf17QLKQB8yaDxhYW46pczZCW71KX1NkVlftTFRlB9FzNc8f6iYiefiiSsPncOy5td4NQNzwK68MvhJ+HoDXDUDac5vdY+RBqx73iowxFUyfukCAno5iTP89eO/566y4CMvPqMdS+1ocfcdDJwZH2bx5xJxrwHmiWFpepk198sNCoG4N72HkTg7/nYJPZFhSlAjNAL21rnOsA0Ty8MVrfIaDeJtdPe1XXhdCX3htyRF4yu7b7G4jD1rp6rcyxmQw1qbDFcYRi0yfRLwHQFhaCsu5G9nShnWYeGsPpsePZQxAlm4i+fSrdikA2ua8UVIcOPXhhqLpM0VoJSWJghfxGkAgP4jUkUurlUyScNovvRIHsSnD0AW/DV3d/d+N1XgAUPlIXwsYU8GYnTHGVRsDE5huchkDY8Hfof8uRL7OdOvM3zvhGYH/vz4ATc/5dsxureNSZ24BvOLJOQBOn2bDqY+dDlq+lJtbRDO3M+Z79t80s3YxZgPpJSL5wOU1nRkFcatXhD7dsQXJLTgZT7w8FdS5+/v2jJx/xYO7HWBMZYw16+AgAqiw3wVEf53vF+09OhXAsQ/24ujbA7MBfDzHAJ729Z0zAGrV5dOnPn5GsVZdYSR4oUBHf6+biKTRK20eZEFO2+pxQp91J/KfjnnMdS/0ub1u6I0R7kx+/3D5A+9bGWMKGFojNV0IovS1YPD1wLET8P/lPTo5dJCBsdwDuP6GF12C/+g3p877SFHgNFsyfl40cxsCNtjwGAEphT6/DSBl9Bv1PixSKb/vXYmbW8tsuCK0mDAXxnjvzdaWEaDyberAERzbM/Tn4z/59KdyCqD4izevDWy0t1LpkrPm1XrGgBeuLf0gUsauFtXFBN7q7e84ubltQpjZjGpyDTbF/L1eMCYPfcmSdvDEjOpmqX3FL4FIBcFioLmN+EzYa7Mh9RJIOig1uhcyeFb1bSsEpjLGNkfTSlnQgn7GmDx0wWqXUdfEjGynqn3piJUIMkBtSWu91MCL9DW7AZIOfmeDZ8HBd89fFQiQwZgllqbLsBbcBsaU/ReWG+rysEz089U8f0gEkUqETQaa21DSm6J9Juw1oB1E6qHrTi94/9Cy9S0nBOYKpVViBwjxgo40ApJuMCYNb6rMyEPNMtlQuq5zzAmQCkJTWuY2cfDC9/MDJB/estFViOCtuvtNkft5m6JppZS0IJIyxV4wJo1csjajbg3LRkdz9TMHJA6ixUBzG6Eto/ia+md6iUg+cuOZBeEfrvz5X6xgTGaMtc3yxxJMkxigBf2MMXXksnVKNq6XZaulvvrpYSsBMijMPzTG3Ia0afy8YxeI5CPfOytv/cOVP/2zBMaUWeZWiGIiE3gvxYCkAwKTD1xekzXXhWV7TsfaXUMiwP1DA8ALactovmZYIKR/3q9PayTVd8tH88Y/XNH+JwfP5zUnFDika4rnvt4NxpTRq2xZtxIsV5OK1uwcdPK0TZOB5jZG+mcOnF4QKf7bHDn1D5f/6I9WMKYwxlpDWilKVJo5LehljCmj36zP2X1guZ7VVvW4N5Q/NBC82doyZlWmm4iU8ds/nvUnf/n/+D8yGFMgwJJS+iR9LdgOxtSxq8WcWgKWD9MqqzoG9Pxh0D80xtzGTf9EaMcOECnjd5yTcf9w2R3dTm5um+YGAXODjnjvpRiQdIEx+eA1jXnhC7N8mtdb+UhfKH+YHfDCNawfBHXiznMzEv0tvf0NkQcYm2PVV2fDZbgp7gVj8qFrN+RVNoDl28RyAKh4cLfuHyIsf5i+uU0stUPkJUA++sNPGtY2Vfb9f1N4g6hlDlyZ14J+xphy6Lun52W9PC8BDEr5A+/HrS8bDF6YBuVtXyD5mHJeytMCym79X04w5gLDrCpGvC4Tg7XgNjCmHL5+Y95WhPIaQAAov+9dKwgyRdaX0zO3yaR2OkAkH/vJZxIexNLWV0UdvLC0SmbSJ7GO2w3GpCM3nelBnkveAxiU1dvf0f1DhOUPMwteRFkP6vGffTauf7jkppfDqhjxNV0qWjABU+wFY7Kv9axOFIgUDIBBsapvO4P1ZQPNbUId3Pq0AEiTdzXPceRLbnhJYrw5NNEuEwO1oJ8xpvpu/aiCApOCAzAoll/1SvHqywaDF+lrdoNImtz6eU/Jd1/gVQw0R/fTIjScECNwSD0g6YDAZP9tjoLs/ClYAAHAsvUtKwCZiNoMNLdhn4nfy0jTgTcDx0+ePRcuJNzankZA0g2B5SSJbgIYIavuelOMXl/ODHgz2jQQQGByKnpUmjkt6AVjysQd57iwAGRBABiUlT//y0x92UBzG7P7hqYD0E5MxUiTZEQLtoMxdeLOTyyYiVgLCsCgrPjJn3n+kCyZAG/mGNPaDIDptr3PE5B0gTH56I8+5VloY7UgAQSAFe1/0vOHRG1GmNtQaicEKU1r0E5OxW5tT98U94Ix+Vj7eW4sUFmwAAZl+Y/+KHKzvMko8IIQ07QGmjoVVokwTAv6GWPKsZ9+ZsFPN13wAAZl2Z3/e6a+nIq5nVvm4xpw6lT8CT7Ja8FtYEw5/vO/WxQT7hcNgEFZ+oNu3T8EWVIFL/iaFtBAp6YTqNsmFJB0gzFp8m6nZzGNx6IDEACW3v5GWH05iQn0EWU+CgcwhhZMwBR7wZh84pef78QilEUJYFDKbvtXkZvlTcmANxMFBzTQqUCC3StR/DyBqSfu+XsFi1gWNYBBKZVfd0avL8eeQE8cQEwHogYX8wQkHWBMOal+0bPY770JYJgsuflVSQcxzD+MAl6oEqJXQxJecYCXz6a2n+8277YJYHQIb3w5an052gR6ChBIC8TUdGFa0A/G5FP3XeAy77AJYEJSsuVFkeDMW8UAAACwSURBVJvlTfGWDKGANt+KA+1gTD31wFd85l01AUxaiq97PlRfjpwiqhFI02LVbbvAmDz94EUe8y6aAKYtRd/pmlVfBvj33GkUaW69YEwKPNJi+nkmgAZDeM1zs+vLwW8cD/l5itZxiWreKRPAjIpw9TOivsaMtknnT599pj1+qennmQBm8eZ94+krQPQe7by8x7wbJoCmFKI1MW+BKSaAppgAmmKKCaApJoCmmJJN+f8yRATGNXIUUAAAAABJRU5ErkJggg==">
</a>
<a class="navbar-brand">
<span class="mapgis-webclient-text"> MapGIS Client for JavaScript（Common） </span>
</a>
<div id="suffix-title">for MapboxGL</div>
</div>
<button
type="button"
class="navbar-toggle collapsed"
data-toggle="collapse"
data-target="#navbar-collapse"
aria-expanded="false"
>
<i class="fa fa-bars"></i>
</button>
</div>
</div>
</nav>
</header>
<div class="navigationDiv">
</div>
<div class="main content-wrapper examples-container">
<h1 class="page-title" data-filename="RendererCollection.html">Class: RendererCollection</h1>
<section>
<header>
<h2></span>RendererCollection
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<div class="nameContainer">
<h4 class="name" id="RendererCollection">
new RendererCollection<span class="signature">(collection)</span>
</h4>
<div class="tag-source">
document/layer/support/RendererCollection.js, line 5
</div>
</div>
</dt>
<dd>
<div class="description">
<p>Renderer集合对象，主要用于M3DModelCacheLayer的renderer属性需要多个Renderer样式的场景</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>collection</code></td>
<td class="type">
<span class="param-type">Array.<Object></span>
</td>
<td class="description last">
<p>render结构集合
这里对object属性结构有要求，需要使用指定两个属性:
layerID：渲染图层ID，字符串类型
renderer：渲染器对象，BaseRenderer类型及其派生类</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Example</h5>
<p class="code-caption"><h7>创建Renderer集合对象</h7></p>
<pre class="prettyprint"><code>const rendererCollection = new zondy.RendererCollection([
{
// 子图层ID
layerID: '1834734999',
// 渲染renderer
renderer: layerRenderer1
},
{
// 子图层ID
layerID: '1834734000',
// 渲染renderer
renderer: layerRenderer2
}
])
layer.renderer = rendererCollection</code></pre>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="Collection.html">Collection</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<div class="nameContainer">
<h4 class="name" id="items">items<span class="type-signature type array.<any>">Array.<any></span> </h4>
</div>
</dt>
<dd>
<div class="description">
<p>数组集合中的元素</p>
</div>
<dl class="details">
</dl>
</dd>
<dt>
<div class="nameContainer">
<h4 class="name" id="length">length<span class="type-signature type number">Number</span> </h4>
</div>
</dt>
<dd>
<div class="description">
<p>数组集合的长度</p>
</div>
<dl class="details">
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="add">
<span class="inherited"><a href="Collection.html#add">inherited</a></span>
add<span class="signature">(item, index)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 94
</div>
</div>
</dt>
<dd>
<div class="description">
<p>添加一个元素到集合中</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
<p>要添加的元素</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<p>指的元素要添加的位置，如果不指定，默认添加到集合末尾</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">添加完元素后的集合对象</td>
</tr>
</tbody>
</table>
<h5>Examples</h5>
<p class="code-caption"><h7 id='add'>添加一个元素到集合中</h7></p>
<pre class="prettyprint"><code>const collection = new Collection()
collection.add({
key: 'value'
})</code></pre>
<p class="code-caption"><h7 id='add2'>添加一个元素到集合中的指定位置</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
collection.add({
key: 'value'
}, 1)</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="addMany">
<span class="inherited"><a href="Collection.html#addMany">inherited</a></span>
addMany<span class="signature">(items, index)</span>
</h4>
<div class="tag-source">
base/Collection.js, line 115
</div>
</div>
</dt>
<dd>
<div class="description">
<p>添加多个元素到集合中，添加完成后会发送数据变更事件</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">Array.<*></span>
</td>
<td class="description last">
<p>要添加的多个元素</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<p>指的元素要添加的位置，如果不指定，默认添加到集合末尾</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Examples</h5>
<p class="code-caption"><h7 id='addMany'>添加多个元素到集合中</h7></p>
<pre class="prettyprint"><code>const collection = new Collection()
collection.addMany([1, 2, 3])</code></pre>
<p class="code-caption"><h7 id='addMany2'>添加多个元素到集合中的指定位置</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
collection.addMany([1, 2, 3], 2)</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="all">
<span class="inherited"><a href="Collection.html#all">inherited</a></span>
all<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<*>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 801
</div>
</div>
</dt>
<dd>
<div class="description">
<p>获取集合中的所有元素并返回一个数组</p>
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
Array.<*>
</td>
<td class="description last">集合中元素构成的数组</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='toArray'>返回集合对象中元素组成的数组</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
collection.all()</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="at">
<span class="inherited"><a href="Collection.html#at">inherited</a></span>
at<span class="signature">(index)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 140
</div>
</div>
</dt>
<dd>
<div class="description">
<p>返回指定下标处的元素</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<p>元素下标，默认从0开始，允许使用正整数和负整数，负整数从集合中的最后一个元素开始倒数</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
*
</td>
<td class="description last">查询到的元素</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='at'>返回指定下标处的元素</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const item = collection.at(1)</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="clone">
<span class="inherited"><a href="Collection.html#clone">inherited</a></span>
clone<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 156
</div>
</div>
</dt>
<dd>
<div class="description">
<p>克隆并返回一个新集合对象</p>
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">克隆后的集合对象</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='clone'>克隆并返回一个新集合对象</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const cloneObj = collection.clone()</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="concat">
<span class="inherited"><a href="Collection.html#concat">inherited</a></span>
concat<span class="signature">(collection)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 173
</div>
</div>
</dt>
<dd>
<div class="description">
<p>将一个数组或者集合对象链接到当前集合对象末尾</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>collection</code></td>
<td class="type">
<span class="param-type">Array</span>
|
<span class="param-type"><a href="Collection.html">Collection</a></span>
</td>
<td class="description last">
<p>要链接的数组或者集合对象</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">链接后的新集合对象</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='concat'>将一个数组或者集合对象链接到当前集合对象末尾</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
collection.concat([{'a': 1}, {'b': 2}])
collection.concat(new Collection([4, 5, 6]))</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="createInstance">
<span class="inherited"><a href="Collection.html#createInstance">inherited</a></span>
createInstance<span class="signature">(item)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 868
</div>
</div>
</dt>
<dd>
<div class="description">
<p>创建实例，可由子类重载</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
<p>要创建的实例对象</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
*
</td>
<td class="description last">创建的实例对象</td>
</tr>
</tbody>
</table>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="every">
<span class="inherited"><a href="Collection.html#every">inherited</a></span>
every<span class="signature">(fn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Boolean}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 206
</div>
</div>
</dt>
<dd>
<div class="description">
<p>检测数组所有元素是否都符合指定条件（通过函数提供）</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">
<p>过滤条件</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
Boolean
</td>
<td class="description last">是否全部满足过滤条件</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='every'>检测数组所有元素是否都符合指定条件</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const isNumber = collection.every(function(item) {
return typeof item === 'number'
})</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="filter">
<span class="inherited"><a href="Collection.html#filter">inherited</a></span>
filter<span class="signature">(fn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 233
</div>
</div>
</dt>
<dd>
<div class="description">
<p>通过一个过滤条件（函数提供）来过滤并返回元素</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">
<p>过滤条件，如果过滤条件不是函数，则返回undefined</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">过滤后的新集合对象</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='filter'>通过一个过滤条件（函数提供）来过滤并返回元素</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3, 4, 5])
const newCollection = collection.filter(function(item) {
return item > 2
})</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="find">
<span class="inherited"><a href="Collection.html#find">inherited</a></span>
find<span class="signature">(fn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 257
</div>
</div>
</dt>
<dd>
<div class="description">
<p>返回第一个符合过滤条件（函数提供）的元素，如果没找到则返回undefined</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">
<p>过滤条件，如果过滤条件不是函数，也返回undefined</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
*
</td>
<td class="description last">第一个符合过滤条件的元素</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='find'>返回第一个符合过滤条件（函数提供）的元素，如果没找到则返回undefined</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3, 4, 5])
const item = collection.find(function(item) {
return item > 2
})</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="findIndex">
<span class="inherited"><a href="Collection.html#findIndex">inherited</a></span>
findIndex<span class="signature">(fn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Number}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 282
</div>
</div>
</dt>
<dd>
<div class="description">
<p>返回第一个符合过滤条件（函数提供）的元素的下标，如果没找到则返回-1</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">
<p>过滤条件</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
Number
</td>
<td class="description last">第一个符合过滤条件（函数提供）的元素的下标</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='findIndex'>返回第一个符合过滤条件（函数提供）的元素的下标，如果没找到则返回-1</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3, 4, 5])
const index = collection.findIndex(function(item) {
return item > 1
})</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="flatten">
<span class="inherited"><a href="Collection.html#flatten">inherited</a></span>
flatten<span class="signature">(fn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 300
</div>
</div>
</dt>
<dd>
<div class="description">
<p>扁平化一个集合对象，通过传入的扁平化函数来指定要扁平化的对象数组，直到指定的对象数组为空或者元素数量为0，之后返回一个新集合对象</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">
<p>扁平化函数，通过该函数来指定要扁平化的对象数组，如果该函数不是一个函数对象，则返回undefined</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">扁平化后的集合对象</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='flatten'>扁平化一个集合对象</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([{
layers: [1, 2, 3]
},{
items: [4, 5, 6]
}])
const flatten = collection.flatten(function(item) {
return item.layers || item.items
})</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="forEach">
<span class="inherited"><a href="Collection.html#forEach">inherited</a></span>
forEach<span class="signature">(fn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 347
</div>
</div>
</dt>
<dd>
<div class="description">
<p>对集合中的所有元素执行传入的函数</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">
<p>针对元素的执行函数，参考js数组的forEach方法</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">执行完函数后的集合对象</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='forEach'>对集合中的所有元素执行传入的函数</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
collection.forEach(function(item) {
console.log("item:", item)
})</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="getItemAt">
<span class="inherited"><a href="Collection.html#getItemAt">inherited</a></span>
getItemAt<span class="signature">(index)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 359
</div>
</div>
</dt>
<dd>
<div class="description">
<p>获取指定下标的元素，没找到则返回undefined</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<p>元素下标</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
*
</td>
<td class="description last">该下标下的元素</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='getItemAt'>获取指定下标的元素</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const item = collection.getItemAt(1)</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="includes">
<span class="inherited"><a href="Collection.html#includes">inherited</a></span>
includes<span class="signature">(item)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Boolean}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 371
</div>
</div>
</dt>
<dd>
<div class="description">
<p>判断集合中是否包含该元素</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
<p>要检查的元素对象</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
Boolean
</td>
<td class="description last">集合中是否包含该元素</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='includes'>判断集合中是否包含该元素</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const isInclude = collection.includes(2)</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="indexOf">
<span class="inherited"><a href="Collection.html#indexOf">inherited</a></span>
indexOf<span class="signature">(item, fromIndex)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Number}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 393
</div>
</div>
</dt>
<dd>
<div class="description">
<p>返回元素在集合中的下标</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
<p>要在集合中寻找的元素</p></td>
</tr>
<tr>
<td class="name"><code>fromIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<p>选择起始下标，默认为0，即从何处开始寻找</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
Number
</td>
<td class="description last">元素在集合中的下标</td>
</tr>
</tbody>
</table>
<h5>Examples</h5>
<p class="code-caption"><h7 id='indexOf'>判断集合中是否包含该元素</h7></p>
<pre class="prettyprint"><code>const item = {
'a': 1
}
const collection = new Collection([item, 2, 3])
const index = collection.indexOf(item)</code></pre>
<p class="code-caption"><h7 id='indexOf2'>判断集合中是否包含该元素-选择起始下标</h7></p>
<pre class="prettyprint"><code>const item = {
'a': 1
}
const collection = new Collection([item, 2, 3, item])
const index = collection.indexOf(item, 1)</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="join">
<span class="inherited"><a href="Collection.html#join">inherited</a></span>
join<span class="signature">(separator)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{String}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 417
</div>
</div>
</dt>
<dd>
<div class="description">
<p>通过传入一个分隔符，将集合中的元素通过分隔符拼接成一个字符串并返回</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>separator</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
<p>分割符号</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
String
</td>
<td class="description last">拼接完成的字符串</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='join'>通过传入一个分隔符，将集合中的元素通过分隔符拼接成一个字符串并返回</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const str = collection.join(',')</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="lastIndexOf">
<span class="inherited"><a href="Collection.html#lastIndexOf">inherited</a></span>
lastIndexOf<span class="signature">(item, fromIndex)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Number}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 438
</div>
</div>
</dt>
<dd>
<div class="description">
<p>从集合的最末尾开始，寻找该元素，并返回元素下标</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
<p>要寻找的元素</p></td>
</tr>
<tr>
<td class="name"><code>fromIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<p>从何处开始查找，默认为集合的长度-1</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
Number
</td>
<td class="description last">第一个找到的元素下标，未找到则返回-1</td>
</tr>
</tbody>
</table>
<h5>Examples</h5>
<p class="code-caption"><h7 id='lastIndexOf'>从集合的最末尾开始，寻找该元素，并返回元素下标</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const index = collection.lastIndexOf(3)</code></pre>
<p class="code-caption"><h7 id='lastIndexOf2'>从集合的最末尾开始，寻找该元素，并返回元素下标 - 指定起始额位置</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3, 3, 3])
const index = collection.lastIndexOf(3, 3)</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="map">
<span class="inherited"><a href="Collection.html#map">inherited</a></span>
map<span class="signature">(fn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 460
</div>
</div>
</dt>
<dd>
<div class="description">
<p>通过一个遍历函数来遍历该集合下的所有元素，并返回一个新集合对象</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">
<p>遍历函数</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">遍历后的新集合对象</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='map'>通过一个遍历函数来遍历该集合下的所有元素，并返回一个新集合对象</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const newCollection = collection.map(function (item) {
return item + 1
})</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="pop">
<span class="inherited"><a href="Collection.html#pop">inherited</a></span>
pop<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 481
</div>
</div>
</dt>
<dd>
<div class="description">
<p>删除并返回集合的最后一个元素</p>
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
*
</td>
<td class="description last">集合的最后一个元素</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='pop'>删除并返回集合的最后一个元素</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const item = collection.pop()</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="push">
<span class="inherited"><a href="Collection.html#push">inherited</a></span>
push<span class="signature">(item)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 493
</div>
</div>
</dt>
<dd>
<div class="description">
<p>添加一个元素到集合中</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
<p>要添加的元素</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">添加完元素后的集合对象</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='push'>添加一个元素到集合中</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
collection.push(4)</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="reduce">
<span class="inherited"><a href="Collection.html#reduce">inherited</a></span>
reduce<span class="signature">(fn, baseValue)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 508
</div>
</div>
</dt>
<dd>
<div class="description">
<p>接收一个函数做为累加器，将集合中的每一个元素(下标从小到大的顺序)进行累加，最后返回一个对象</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">
<p>累加器函数</p></td>
</tr>
<tr>
<td class="name"><code>baseValue</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
<p>累加的基础对象</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
*
</td>
<td class="description last">累加后的对象</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='reduce'>接收一个函数做为累加器，将集合中的每一个元素(下标从小到大的顺序)进行累加，最后返回一个对象</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const sum = collection.reduce(function (reduceCarry, item) {
return reduceCarry += item
}, 0)</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="reduceRight">
<span class="inherited"><a href="Collection.html#reduceRight">inherited</a></span>
reduceRight<span class="signature">(fn, baseValue)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 539
</div>
</div>
</dt>
<dd>
<div class="description">
<p>接收一个函数做为累加器，将集合中的每一个元素(下标从大到小的顺序)进行累加，最后返回一个对象</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">
<p>累加器函数</p></td>
</tr>
<tr>
<td class="name"><code>baseValue</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
<p>累加的基础对象</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
*
</td>
<td class="description last">累加后的对象</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='reduceRight'>接收一个函数做为累加器，将集合中的每一个元素(下标从大到小的顺序)进行累加，最后返回一个对象</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const sum = collection.reduce(function (reduceCarry, item) {
console.log(item)
})</code></pre>
</dd>
<dt>
<div class="nameContainer">
<h4 class="name" id="remove">
remove<span class="signature">(item)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
</h4>
<div class="tag-source">
document/layer/support/RendererCollection.js, line 81
</div>
</div>
</dt>
<dd>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type">item</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
*
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dd>
<dt>
<div class="nameContainer">
<h4 class="name" id="removeAll">
removeAll<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
</h4>
<div class="tag-source">
document/layer/support/RendererCollection.js, line 101
</div>
</div>
</dt>
<dd>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
*
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dd>
<dt>
<div class="nameContainer">
<h4 class="name" id="removeAt">
removeAt<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
</h4>
<div class="tag-source">
document/layer/support/RendererCollection.js, line 116
</div>
</div>
</dt>
<dd>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
*
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dd>
<dt>
<div class="nameContainer">
<h4 class="name" id="removeMany">
removeMany<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
</h4>
<div class="tag-source">
document/layer/support/RendererCollection.js, line 90
</div>
</div>
</dt>
<dd>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
*
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="reorder">
<span class="inherited"><a href="Collection.html#reorder">inherited</a></span>
reorder<span class="signature">(item, index)</span>
</h4>
<div class="tag-source">
base/Collection.js, line 641
</div>
</div>
</dt>
<dd>
<div class="description">
<p>将指的元素调整到集合中指的下标位置</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
<p>要排序的元素</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<p>元素要调整到的位置</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Example</h5>
<p class="code-caption"><h7 id='reorder'>将指的元素调整到集合中指的下标位置</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
collection.reorder(1, 2)</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="reverse">
<span class="inherited"><a href="Collection.html#reverse">inherited</a></span>
reverse<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 659
</div>
</div>
</dt>
<dd>
<div class="description">
<p>将集合对象中的元素反转，并返回新集合对象</p>
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">新的集合对象</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='reverse'>将集合对象中的元素反转，并返回新集合对象</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const newCollection = collection.reverse()</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="shift">
<span class="inherited"><a href="Collection.html#shift">inherited</a></span>
shift<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 671
</div>
</div>
</dt>
<dd>
<div class="description">
<p>删除并返回集合的第一个元素（元素下标为0）</p>
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
*
</td>
<td class="description last">集合的第一个元素</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='reverse'>删除并返回集合的第一个元素</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const item = collection.shift()</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="slice">
<span class="inherited"><a href="Collection.html#slice">inherited</a></span>
slice<span class="signature">(start, end)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 684
</div>
</div>
</dt>
<dd>
<div class="description">
<p>截取集合中从start开始到end下标的元素，并返回一个新集合对象</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>start</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<p>从0开始的元素小标</p></td>
</tr>
<tr>
<td class="name"><code>end</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<p>截至的元素下标，不填则默认到集合最后一个元素</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">新集合对象</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='slice'>截取集合中从start开始到end下标的元素，并返回一个新集合对象</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3, 4, 5])
const newCollection = collection.slice(1, 3)</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="some">
<span class="inherited"><a href="Collection.html#some">inherited</a></span>
some<span class="signature">(fn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Boolean}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 704
</div>
</div>
</dt>
<dd>
<div class="description">
<p>判断集合对象中的元素是否满足过滤条件，只要有一个元素满足过滤条件，则会返回true，如果都不满足过滤条件，则返回false</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">
<p>过滤条件，如果过滤条件不是函数，也返回false</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
Boolean
</td>
<td class="description last">是否满足过滤条件</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='some'>判断集合对象中的元素是否满足过滤条件</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3, 4, 5])
const flag = collection.some(function (item) {
return item === 1
})</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="sort">
<span class="inherited"><a href="Collection.html#sort">inherited</a></span>
sort<span class="signature">(fn)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 734
</div>
</div>
</dt>
<dd>
<div class="description">
<p>通过一个排序函数来对当前的集合进行排序，之后返回一个新集合对象，参考js的sort函数</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fn</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">
<p>排序函数，不填则默认按从小到达排序</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">新的集合对象</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='sort'>通过一个排序函数来对当前的集合进行排序，之后返回一个新集合对象</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([{
'a': 2
},{
'a': 1
},{
'a': 3
}])
const newCollection = collection.sort(function (itemA, itemB) {
return itemA.a - itemB.a
})</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="splice">
<span class="inherited"><a href="Collection.html#splice">inherited</a></span>
splice<span class="signature">(start, deleteCount, items)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 763
</div>
</div>
</dt>
<dd>
<div class="description">
<p>向集合中删除或添加一个元素，参考js的splice方法</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>start</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<p>删除或添加的起始下标</p></td>
</tr>
<tr>
<td class="name"><code>deleteCount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<p>删除或添加的数量</p></td>
</tr>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
<span class="repeatable">repeatable</span>
<p>要删除或添加的元素</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">新的集合对象</td>
</tr>
</tbody>
</table>
<h5>Examples</h5>
<p class="code-caption"><h7 id='splice'>向集合中删除一个元素</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
const newCollection = collection.splice(1, 1)</code></pre>
<p class="code-caption"><h7 id='splice2'>向集合中添加一个元素</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
collection.splice(1, 0, 1)</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="toArray">
<span class="inherited"><a href="Collection.html#toArray">inherited</a></span>
toArray<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 775
</div>
</div>
</dt>
<dd>
<div class="description">
<p>返回集合对象中元素组成的数组</p>
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
Array
</td>
<td class="description last">集合对象中元素组成的数组</td>
</tr>
</tbody>
</table>
<h5>Example</h5>
<p class="code-caption"><h7 id='toArray'>返回集合对象中元素组成的数组</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
collection.toArray()</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="unique">
<span class="inherited"><a href="Collection.html#unique">inherited</a></span>
unique<span class="signature">(key)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Collection.html">Collection</a>}</span>
</h4>
<div class="tag-source">
base/Collection.js, line 829
</div>
</div>
</dt>
<dd>
<div class="description">
<p>去除集合中的重复元素</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">function</span>
|
<span class="param-type">String</span>
</td>
<td class="description last">
<p>指定一个去重函数或者要素的去重字段</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<a href="Collection.html">Collection</a>
</td>
<td class="description last">去重后的集合对象</td>
</tr>
</tbody>
</table>
<h5>Examples</h5>
<p class="code-caption">No Arguments</p>
<pre class="prettyprint"><code>const unique = new Collection([2, 1, 2, 3, 3, 4, 5, 1, 2]).unique();
console.log(unique); // [2, 1, 3, 4, 5]</code></pre>
<p class="code-caption">Property Name</p>
<pre class="prettyprint"><code>const students = new Collection([
{ name: 'Rick', grade: 'A'},
{ name: 'Mick', grade: 'B'},
{ name: 'Richard', grade: 'A'},
]);
// Students with unique grades.
students.unique('grade'); // [{ name: 'Rick', grade: 'A'}, { name: 'Mick', grade: 'B'}]</code></pre>
<p class="code-caption">With Callback</p>
<pre class="prettyprint"><code>const students = new Collection([
{ name: 'Rick', grade: 'A'},
{ name: 'Mick', grade: 'B'},
{ name: 'Richard', grade: 'A'},
]);
// Students with unique grades.
students.unique(s => s.grade); // [{ name: 'Rick', grade: 'A'}, { name: 'Mick', grade: 'B'}]</code></pre>
</dd>
<dt>
<div class="nameContainer inherited">
<h4 class="name" id="unshift">
<span class="inherited"><a href="Collection.html#unshift">inherited</a></span>
unshift<span class="signature">(items)</span>
</h4>
<div class="tag-source">
base/Collection.js, line 790
</div>
</div>
</dt>
<dd>
<div class="description">
<p>向集合起始位置添加一个或多个元素</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
<span class="repeatable">repeatable</span>
<p>要添加的一个或多个元素</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Example</h5>
<p class="code-caption"><h7 id='toArray'>返回集合对象中元素组成的数组</h7></p>
<pre class="prettyprint"><code>const collection = new Collection([1, 2, 3])
collection.unshift(1, 2)</code></pre>
</dd>
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 10:41:58 GMT+0800 (中国标准时间)
</footer>
</div>
</div>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/main.js"></script>
</body>
</html>