text
stringlengths 2
1.05M
| repo_name
stringlengths 5
101
| path
stringlengths 4
991
| language
stringclasses 3
values | license
stringclasses 5
values | size
int64 2
1.05M
|
|---|---|---|---|---|---|
<!DOCTYPE html>
<html ng-app="cleanUI">
<head lang="en">
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>Clean UI Admin Template</title>
<link href="../assets/common/img/favicon.144x144.png" rel="apple-touch-icon" type="image/png" sizes="144x144">
<link href="../assets/common/img/favicon.114x114.png" rel="apple-touch-icon" type="image/png" sizes="114x114">
<link href="../assets/common/img/favicon.72x72.png" rel="apple-touch-icon" type="image/png" sizes="72x72">
<link href="../assets/common/img/favicon.57x57.png" rel="apple-touch-icon" type="image/png">
<link href="../assets/common/img/favicon.png" rel="icon" type="image/png">
<link href="../favicon.ico" rel="shortcut icon">
<!-- HTML5 shim and Respond.js for < IE9 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<!-- Vendors Styles -->
<!-- v1.0.0 -->
<link rel="stylesheet" type="text/css" href="../assets/vendors/bootstrap/dist/css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/jscrollpane/style/jquery.jscrollpane.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/ladda/dist/ladda-themeless.min.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/select2/dist/css/select2.min.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/eonasdan-bootstrap-datetimepicker/build/css/bootstrap-datetimepicker.min.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/fullcalendar/dist/fullcalendar.min.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/cleanhtmlaudioplayer/src/player.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/cleanhtmlvideoplayer/src/player.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/bootstrap-sweetalert/dist/sweetalert.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/summernote/dist/summernote.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/owl.carousel/dist/assets/owl.carousel.min.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/ionrangeslider/css/ion.rangeSlider.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/datatables/media/css/dataTables.bootstrap4.min.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/c3/c3.min.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/chartist/dist/chartist.min.css">
<!-- v1.4.0 -->
<link rel="stylesheet" type="text/css" href="../assets/vendors/nprogress/nprogress.css">
<link rel="stylesheet" type="text/css" href="../assets/vendors/jquery-steps/demo/css/jquery.steps.css">
<!-- v1.4.2 -->
<link rel="stylesheet" type="text/css" href="../assets/vendors/bootstrap-select/dist/css/bootstrap-select.min.css">
<!-- v1.7.0 -->
<link rel="stylesheet" type="text/css" href="../assets/vendors/dropify/dist/css/dropify.min.css">
<!-- Clean UI Styles -->
<link rel="stylesheet" type="text/css" href="../assets/common/css/source/main.css">
<!-- Vendors Scripts -->
<!-- v1.0.0 -->
<script src="../assets/vendors/jquery/jquery.min.js"></script>
<script src="../assets/vendors/tether/dist/js/tether.min.js"></script>
<script src="../assets/vendors/bootstrap/dist/js/bootstrap.min.js"></script>
<script src="../assets/vendors/jquery-mousewheel/jquery.mousewheel.min.js"></script>
<script src="../assets/vendors/jscrollpane/script/jquery.jscrollpane.min.js"></script>
<script src="../assets/vendors/spin.js/spin.js"></script>
<script src="../assets/vendors/ladda/dist/ladda.min.js"></script>
<script src="../assets/vendors/select2/dist/js/select2.full.min.js"></script>
<script src="../assets/vendors/html5-form-validation/dist/jquery.validation.min.js"></script>
<script src="../assets/vendors/jquery-typeahead/dist/jquery.typeahead.min.js"></script>
<script src="../assets/vendors/jquery-mask-plugin/dist/jquery.mask.min.js"></script>
<script src="../assets/vendors/autosize/dist/autosize.min.js"></script>
<script src="../assets/vendors/bootstrap-show-password/bootstrap-show-password.min.js"></script>
<script src="../assets/vendors/moment/min/moment.min.js"></script>
<script src="../assets/vendors/eonasdan-bootstrap-datetimepicker/build/js/bootstrap-datetimepicker.min.js"></script>
<script src="../assets/vendors/fullcalendar/dist/fullcalendar.min.js"></script>
<script src="../assets/vendors/cleanhtmlaudioplayer/src/jquery.cleanaudioplayer.js"></script>
<script src="../assets/vendors/cleanhtmlvideoplayer/src/jquery.cleanvideoplayer.js"></script>
<script src="../assets/vendors/bootstrap-sweetalert/dist/sweetalert.min.js"></script>
<script src="../assets/vendors/remarkable-bootstrap-notify/dist/bootstrap-notify.min.js"></script>
<script src="../assets/vendors/summernote/dist/summernote.min.js"></script>
<script src="../assets/vendors/owl.carousel/dist/owl.carousel.min.js"></script>
<script src="../assets/vendors/ionrangeslider/js/ion.rangeSlider.min.js"></script>
<script src="../assets/vendors/nestable/jquery.nestable.js"></script>
<script src="../assets/vendors/datatables/media/js/jquery.dataTables.min.js"></script>
<script src="../assets/vendors/datatables/media/js/dataTables.bootstrap4.min.js"></script>
<script src="../assets/vendors/datatables-fixedcolumns/js/dataTables.fixedColumns.js"></script>
<script src="../assets/vendors/datatables-responsive/js/dataTables.responsive.js"></script>
<script src="../assets/vendors/editable-table/mindmup-editabletable.js"></script>
<script src="../assets/vendors/d3/d3.min.js"></script>
<script src="../assets/vendors/c3/c3.min.js"></script>
<script src="../assets/vendors/chartist/dist/chartist.min.js"></script>
<script src="../assets/vendors/peity/jquery.peity.min.js"></script>
<!-- v1.0.1 -->
<script src="../assets/vendors/chartist-plugin-tooltip/dist/chartist-plugin-tooltip.min.js"></script>
<!-- v1.1.1 -->
<script src="../assets/vendors/gsap/src/minified/TweenMax.min.js"></script>
<script src="../assets/vendors/hackertyper/hackertyper.js"></script>
<script src="../assets/vendors/jquery-countTo/jquery.countTo.js"></script>
<!-- v1.4.0 -->
<script src="../assets/vendors/nprogress/nprogress.js"></script>
<script src="../assets/vendors/jquery-steps/build/jquery.steps.min.js"></script>
<!-- v1.4.2 -->
<script src="../assets/vendors/bootstrap-select/dist/js/bootstrap-select.min.js"></script>
<script src="../assets/vendors/chart.js/src/Chart.bundle.min.js"></script>
<!-- v1.7.0 -->
<script src="../assets/vendors/dropify/dist/js/dropify.min.js"></script>
<!-- Angular Version Scripts -->
<script src="../assets/vendors/angular/angular.min.js"></script>
<script src="../assets/vendors/angular-route/angular-route.min.js"></script>
<script src="../assets/common/js/version_angular/app.js"></script>
<!-- Angular Version Controllers -->
<script src="pages/register.ctrl.js"></script>
<script src="pages/login.ctrl.js"></script>
<script src="pages/lockscreen.ctrl.js"></script>
<!-- Clean UI Scripts -->
<script src="../assets/common/js/common.js"></script>
<script src="../assets/common/js/demo.temp.js"></script>
</head>
<body class="theme-default layout-boxed menu-static colorful-enabled" ng-controller="MainCtrl">
<nav class="left-menu" left-menu ng-class="{'hidden-left-menu': hideLeftMenu}">
<div class="logo-container">
<a href="#/dashboards/alpha" class="logo">
<img src="../assets/common/img/logo.png" alt="Clean UI Admin Template" />
<img class="logo-inverse" src="../assets/common/img/logo-inverse.png" alt="Clean UI Admin Template" />
</a>
</div>
<div class="left-menu-inner scroll-pane">
<ul class="left-menu-list left-menu-list-root list-unstyled">
<li class="left-menu-list-submenu">
<a class="left-menu-link" href="javascript: void(0);">
<i class="left-menu-link-icon icmn-cog util-spin-delayed-pseudo"><!-- --></i>
<span class="menu-top-hidden">Theme</span> Settings
</a>
<ul class="left-menu-list list-unstyled">
<li>
<div class="left-menu-item">
<div class="left-menu-block">
<div class="left-menu-block-item">
<small>This menu gives possibility to construct custom blocks with any widgets, components and elements inside, like this theme settings</small>
</div>
<div class="left-menu-block-item">
<span class="font-weight-600">Theme Style:</span>
</div>
<div class="left-menu-block-item" id="options-theme">
<div class="btn-group btn-group-justified" data-toggle="buttons">
<div class="btn-group">
<label class="btn btn-default active">
<input type="radio" name="options-theme" value="theme-default" autocomplete="off" checked=""> Light
</label>
</div>
<div class="btn-group">
<label class="btn btn-default">
<input type="radio" name="options-theme" value="theme-dark" autocomplete="off"> Dark
</label>
</div>
</div>
<div class="btn-group btn-group-justified" data-toggle="buttons">
<div class="btn-group">
<label class="btn btn-default">
<input type="radio" name="options-theme" value="theme-green" autocomplete="off"> Green
</label>
</div>
<div class="btn-group">
<label class="btn btn-default">
<input type="radio" name="options-theme" value="theme-blue" autocomplete="off"> Blue
</label>
</div>
</div>
<div class="btn-group btn-group-justified" data-toggle="buttons">
<div class="btn-group">
<label class="btn btn-default">
<input type="radio" name="options-theme" value="theme-red" autocomplete="off"> Red
</label>
</div>
<div class="btn-group">
<label class="btn btn-default">
<input type="radio" name="options-theme" value="theme-orange" autocomplete="off"> Orange
</label>
</div>
</div>
</div>
<div class="left-menu-block-item">
<span class="font-weight-600">Fixed Top Menu</sup>:</span>
</div>
<div class="left-menu-block-item" id="options-menu">
<div class="btn-group btn-group-justified" data-toggle="buttons">
<div class="btn-group">
<label class="btn btn-default active">
<input type="radio" name="options-menu" value="menu-fixed" checked=""> On
</label>
</div>
<div class="btn-group">
<label class="btn btn-default">
<input type="radio" name="options-menu" value="menu-static"> Off
</label>
</div>
</div>
</div>
<div class="left-menu-block-item">
<span class="font-weight-600">Super Clean Mode:</span>
</div>
<div class="left-menu-block-item" id="options-mode">
<div class="btn-group btn-group-justified" data-toggle="buttons">
<div class="btn-group">
<label class="btn btn-default">
<input type="radio" name="options-mode" value="mode-superclean"> On
</label>
</div>
<div class="btn-group">
<label class="btn btn-default active">
<input type="radio" name="options-mode" value="mode-default" checked=""> Off
</label>
</div>
</div>
</div>
<div class="left-menu-block-item">
<span class="font-weight-600">Colorful Menu:</span>
</div>
<div class="left-menu-block-item" id="options-colorful">
<div class="btn-group btn-group-justified" data-toggle="buttons">
<div class="btn-group">
<label class="btn btn-default active">
<input type="radio" name="options-colorful" value="colorful-enabled" checked=""> On
</label>
</div>
<div class="btn-group">
<label class="btn btn-default">
<input type="radio" name="options-colorful" value="colorful-disabled"> Off
</label>
</div>
</div>
</div>
<div class="left-menu-block-item">
<span class="font-weight-600">Menu Shadow:</span>
</div>
<div class="left-menu-block-item" id="mode-box-shadow">
<div class="btn-group btn-group-justified" data-toggle="buttons">
<div class="btn-group">
<label class="btn btn-default">
<input type="radio" name="mode-box-shadow" value="mode-box-shadow"> On
</label>
</div>
<div class="btn-group">
<label class="btn btn-default active">
<input type="radio" name="mode-box-shadow" value="mode-box-shadow-disabled" checked=""> Off
</label>
</div>
</div>
</div>
<div class="left-menu-block-item">
<span class="font-weight-600">Squared Corners:</span>
</div>
<div class="left-menu-block-item" id="mode-squared">
<div class="btn-group btn-group-justified" data-toggle="buttons">
<div class="btn-group">
<label class="btn btn-default">
<input type="radio" name="mode-squared" value="mode-squared"> On
</label>
</div>
<div class="btn-group">
<label class="btn btn-default active">
<input type="radio" name="mode-squared" value="mode-squared-disabled" checked=""> Off
</label>
</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</li>
<li>
<a class="left-menu-link" href="#/documentation/index">
<i class="left-menu-link-icon icmn-books"><!-- --></i>
Documentation
</a>
</li>
<li class="left-menu-list-separator"><!-- --></li>
<li>
<a class="left-menu-link" href="#/dashboards/alpha">
<i class="left-menu-link-icon icmn-home2"><!-- --></i>
<span class="menu-top-hidden">Dashboard</span> Alpha
</a>
</li>
<li>
<a class="left-menu-link" href="#/dashboards/beta">
<i class="left-menu-link-icon icmn-home2"><!-- --></i>
<span class="menu-top-hidden">Dashboard</span> Beta
</a>
</li>
<li class="left-menu-list-separator"><!-- --></li>
<li class="left-menu-list-submenu">
<a class="left-menu-link" href="javascript: void(0);">
<i class="left-menu-link-icon icmn-files-empty2"><!-- --></i>
Default Pages
</a>
<ul class="left-menu-list list-unstyled">
<li>
<a class="left-menu-link" href="#/pages/login-alpha">
Login Alpha
</a>
</li>
<li>
<a class="left-menu-link" href="#/pages/login-beta">
Login Beta
</a>
</li>
<li>
<a class="left-menu-link" href="#/pages/login-omega">
Login Omega
</a>
</li>
<li>
<a class="left-menu-link" href="#/pages/register">
Register
</a>
</li>
<li>
<a class="left-menu-link" href="#/pages/lockscreen">
Lockscreen
</a>
</li>
<li>
<a class="left-menu-link" href="#/pages/pricing-tables">
Pricing Tables
</a>
</li>
<li>
<a class="left-menu-link" href="#/pages/invoice">
Invoice
</a>
</li>
<li>
<a class="left-menu-link" href="#/pages/page-404">
Page 404
</a>
</li>
<li>
<a class="left-menu-link" href="#/pages/page-500">
Page 500
</a>
</li>
</ul>
</li>
<li class="left-menu-list-submenu">
<a class="left-menu-link" href="javascript: void(0);">
<i class="left-menu-link-icon icmn-cart5"><!-- --></i>
Ecommerce
</a>
<ul class="left-menu-list list-unstyled">
<li>
<a class="left-menu-link" href="#/ecommerce/dashboard">
Dashboard
</a>
</li>
<li>
<a class="left-menu-link" href="#/ecommerce/products-catalog">
Products Catalog
</a>
</li>
<li>
<a class="left-menu-link" href="#/ecommerce/product-details">
Product Details
</a>
</li>
<li>
<a class="left-menu-link" href="#/ecommerce/product-edit">
Product Edit
</a>
</li>
<li>
<a class="left-menu-link" href="#/ecommerce/products-list">
Products List
</a>
</li>
<li>
<a class="left-menu-link" href="#/ecommerce/orders">
Orders
</a>
</li>
<li>
<a class="left-menu-link" href="#/ecommerce/cart-checkout">
Cart / Checkout
</a>
</li>
</ul>
</li>
<li class="left-menu-list-separator"><!-- --></li>
<li class="left-menu-list-submenu">
<a class="left-menu-link" href="javascript: void(0);">
<i class="left-menu-link-icon icmn-pencil5"><!-- --></i>
Forms
</a>
<ul class="left-menu-list list-unstyled">
<li>
<a class="left-menu-link" href="#/forms/basic-form-elements">
Basic Form Elements
</a>
</li>
<li>
<a class="left-menu-link" href="#/forms/buttons">
Buttons
</a>
</li>
<li>
<a class="left-menu-link" href="#/forms/dropdowns">
Dropdowns
</a>
</li>
<li>
<a class="left-menu-link" href="#/forms/selectboxes">
Selectboxes
</a>
</li>
<li>
<a class="left-menu-link" href="#/forms/checkboxes-radio">
Checkboxes / Radio
</a>
</li>
<li>
<a class="left-menu-link" href="#/forms/form-wizard">
Form Wizard
</a>
</li>
<li>
<a class="left-menu-link" href="#/forms/form-validation">
Form Validation
</a>
</li>
<li>
<a class="left-menu-link" href="#/forms/autocomplete">
Autocomplete
</a>
</li>
<li>
<a class="left-menu-link" href="#/forms/input-mask">
Input Mask
</a>
</li>
<li>
<a class="left-menu-link" href="#/forms/file-uploads">
File Uploads
</a>
</li>
<li>
<a class="left-menu-link" href="#/forms/extras">
Extras
</a>
</li>
</ul>
</li>
<li class="left-menu-list-submenu">
<a class="left-menu-link" href="javascript: void(0);">
<i class="left-menu-link-icon icmn-stack3"><!-- --></i>
Components
</a>
<ul class="left-menu-list list-unstyled">
<li>
<a class="left-menu-link" href="#/components/date-picker">
Date Picker
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/calendar">
Calendar
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/carousel">
Carousel
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/media-players">
Media Players <span class="label left-menu-label label-default">22$ FREE</span>
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/slider">
Slider
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/modal">
Modal
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/tooltips-popovers">
Tooltips & Popovers
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/notifications-alerts">
Notifications & Alerts
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/loading-progress">
Loading Progress
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/progress-bars">
Progress Bars
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/badges-labels">
Badges & Labels
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/steps">
Steps
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/breadcrumbs">
Breadcrumbs
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/pagination">
Pagination
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/collapse">
Collapse
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/tabs">
Tabs
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/text-editor">
Text Editor
</a>
</li>
<li>
<a class="left-menu-link" href="#/components/nestable">
Nestable
</a>
</li>
</ul>
</li>
<li class="left-menu-list-submenu">
<a class="left-menu-link" href="javascript: void(0);">
<i class="left-menu-link-icon icmn-grid3"><!-- --></i>
Tables
</a>
<ul class="left-menu-list list-unstyled">
<li>
<a class="left-menu-link" href="#/tables/basic-tables">
Basic Tables
</a>
</li>
<li>
<a class="left-menu-link" href="#/tables/datatables">
DataTables
</a>
</li>
<li>
<a class="left-menu-link" href="#/tables/editable-tables">
Editable Tables
</a>
</li>
</ul>
</li>
<li class="left-menu-list-submenu">
<a class="left-menu-link" href="javascript: void(0);">
<i class="left-menu-link-icon icmn-pie-chart2"><!-- --></i>
Charts
</a>
<ul class="left-menu-list list-unstyled">
<li>
<a class="left-menu-link" href="#/charts/chartistjs">
Chartist.js
</a>
</li>
<li>
<a class="left-menu-link" href="#/charts/chartjs">
Chart.js
</a>
</li>
<li>
<a class="left-menu-link" href="#/charts/c3">
C3
</a>
</li>
<li>
<a class="left-menu-link" href="#/charts/peity">
Peity
</a>
</li>
</ul>
</li>
<li>
<a class="left-menu-link" href="#/components/mail-templates">
<i class="left-menu-link-icon icmn-mail2"><!-- --></i>
Mail Templates
</a>
</li>
<li class="left-menu-list-separator"><!-- --></li>
<li>
<a class="left-menu-link" href="#/apps/profile">
<i class="left-menu-link-icon icmn-profile"><!-- --></i>
Profile
</a>
</li>
<li>
<a class="left-menu-link" href="#/apps/messaging">
<i class="left-menu-link-icon icmn-bubbles5"><!-- --></i>
Messaging
</a>
</li>
<li>
<a class="left-menu-link" href="#/apps/mail">
<i class="left-menu-link-icon icmn-mail2"><!-- --></i>
Mail
</a>
</li>
<li>
<a class="left-menu-link" href="#/apps/calendar">
<i class="left-menu-link-icon icmn-calendar"><!-- --></i>
Calendar
</a>
</li>
<li>
<a class="left-menu-link" href="#/apps/gallery">
<i class="left-menu-link-icon icmn-images"><!-- --></i>
Gallery
</a>
</li>
<li class="left-menu-list-separator"><!-- --></li>
<li class="left-menu-list-submenu">
<a class="left-menu-link" href="javascript: void(0);">
<i class="left-menu-link-icon icmn-stack3"><!-- --></i>
Layout
</a>
<ul class="left-menu-list list-unstyled">
<li>
<a class="left-menu-link" href="#/layout/grid">
Grid
</a>
</li>
<li>
<a class="left-menu-link" href="#/layout/panels">
Panels / Cards
</a>
</li>
<li>
<a class="left-menu-link" href="#/layout/sidebars">
Sidebars
</a>
</li>
<li>
<a class="left-menu-link" href="#/layout/utilities">
Utilities
</a>
</li>
</ul>
</li>
<li class="left-menu-list-submenu">
<a class="left-menu-link" href="javascript: void(0);">
<i class="left-menu-link-icon icmn-star-full"><!-- --></i>
Icons
</a>
<ul class="left-menu-list list-unstyled">
<li>
<a class="left-menu-link" href="#/icons/icomoon-ultimate">
IcoMoon Ultimate <span class="label left-menu-label label-default">59$ FREE</span>
</a>
</li>
<li>
<a class="left-menu-link" href="#/icons/fontawesome">
FontAwesome
</a>
</li>
</ul>
</li>
<li>
<a class="left-menu-link" href="#/layout/typography">
<i class="left-menu-link-icon icmn-font-size"><!-- --></i>
Typography
</a>
</li>
<li class="left-menu-list-separator"><!-- --></li>
<li class="left-menu-list-disabled">
<a class="left-menu-link" href="javascript: void(0);">
Disabled Item
</a>
</li>
<!-- remove "horizontal-left-direction" class, for get submenu with right direction (horizontal menu option) -->
<li class="left-menu-list-submenu horizontal-left-direction">
<a class="left-menu-link" href="javascript: void(0);">
Infinity Nested
</a>
<!-- level 1 -->
<ul class="left-menu-list list-unstyled">
<li class="left-menu-list-submenu">
<a class="left-menu-link" href="javascript: void(0);">
Level 1
</a>
<!-- level 2 -->
<ul class="left-menu-list list-unstyled">
<li class="left-menu-list-submenu">
<a class="left-menu-link" href="javascript: void(0);">
Level 1.2
</a>
<!-- level 3 -->
<ul class="left-menu-list list-unstyled">
<li>
<a class="left-menu-link" href="javascript: void(0);">
Level 1.2.3
</a>
</li>
<li class="left-menu-list-submenu">
<a class="left-menu-link" href="javascript: void(0);">
Level 1.2.3
</a>
<!-- level 4 -->
<ul class="left-menu-list list-unstyled">
<li>
<a class="left-menu-link" href="javascript: void(0);">
Level 1.2.3.4
</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a class="left-menu-link" href="javascript: void(0);">
Level 1.2
</a>
</li>
<li>
<a class="left-menu-link" href="javascript: void(0);">
Level 1.2
</a>
</li>
<li>
<a class="left-menu-link" href="javascript: void(0);">
Level 1.2
</a>
</li>
</ul>
</li>
<li>
<a class="left-menu-link" href="javascript: void(0);">
Level 1
</a>
</li>
</ul>
</li>
<li class="left-menu-list-separator"><!-- --></li>
<li class="menu-top-hidden no-colorful-menu">
<div class="left-menu-item">
Last Week Sales
</div>
</li>
<li class="menu-top-hidden no-colorful-menu">
<div class="example-left-menu-chart chartist-animated chartist-theme-dark"></div>
<script>
$(function () {
// CSS STYLING & ANIMATIONS
var cssAnimationData = {
labels: ["S", "M", "T", "W", "T", "F", "S"],
series: [
[11, 14, 16, 16, 20, 17, 21]
]
},
cssAnimationOptions = {
fullWidth: !0,
chartPadding: {
right: 2,
left: 30
},
axisY: {
position: 'end'
}
},
cssAnimationResponsiveOptions = [
[{
axisX: {
labelInterpolationFnc: function(value, index) {
return index % 2 !== 0 ? !1 : value
}
}
}]
];
new Chartist.Line(".example-left-menu-chart", cssAnimationData, cssAnimationOptions, cssAnimationResponsiveOptions);
});
</script>
</li>
<li class="menu-top-hidden no-colorful-menu">
<div class="left-menu-item">
Solar System
</div>
</li>
<li class="menu-top-hidden">
<div class="left-menu-item">
<span class="donut donut-success"></span> Jupiter
</div>
</li>
<li class="menu-top-hidden">
<div class="left-menu-item">
<span class="donut donut-primary"></span> Earth
</div>
</li>
<li class="menu-top-hidden">
<div class="left-menu-item">
<span class="donut donut-danger"></span> Mercury
</div>
</li>
</ul>
</div>
</nav>
<nav class="top-menu" ng-class="{'hidden-top-menu': hideTopMenu}">
<div class="menu-icon-container hidden-md-up">
<div class="animate-menu-button left-menu-toggle">
<div><!-- --></div>
</div>
</div>
<div class="menu">
<div class="menu-user-block">
<div class="dropdown dropdown-avatar">
<a href="javascript: void(0);" class="dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
<span class="avatar" href="javascript:void(0);">
<img src="../assets/common/img/temp/avatars/1.jpg" alt="Alternative text to the image">
</span>
</a>
<ul class="dropdown-menu dropdown-menu-right" aria-labelledby="" role="menu">
<a class="dropdown-item" href="javascript:void(0)"><i class="dropdown-icon icmn-user"></i> Profile</a>
<div class="dropdown-divider"></div>
<div class="dropdown-header">Home</div>
<a class="dropdown-item" href="javascript:void(0)"><i class="dropdown-icon icmn-circle-right"></i> System Dashboard</a>
<a class="dropdown-item" href="javascript:void(0)"><i class="dropdown-icon icmn-circle-right"></i> User Boards</a>
<a class="dropdown-item" href="javascript:void(0)"><i class="dropdown-icon icmn-circle-right"></i> Issue Navigator (35 New)</a>
<div class="dropdown-divider"></div>
<a class="dropdown-item" href="javascript:void(0)"><i class="dropdown-icon icmn-exit"></i> Logout</a>
</ul>
</div>
</div>
<div class="menu-user-block menu-notifications">
<div class="dropdown dropdown-avatar">
<a href="javascript: void(0);" class="dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
<i class="menu-notification-icon icmn-bubbles7"></i>
</a>
<ul class="dropdown-menu dropdown-menu-right" aria-labelledby="" role="menu">
<div class="notification-block">
<div class="item">
<i class="notification-icon icmn-star-full"></i>
<div class="inner">
<div class="title">
<span class="pull-right">now</span>
<a href="javascript: void(0);">Update Status: <span class="label label-danger font-weight-700">New</span></a>
</div>
<div class="descr">
Failed to get available update data. To ensure the proper functioning of your application, update now.
</div>
</div>
</div>
<div class="item">
<i class="notification-icon icmn-stack3"></i>
<div class="inner">
<div class="title">
<span class="pull-right">24 min ago</span>
<a href="javascript: void(0);">Income: <span class="label label-default font-weight-700">$299.00</span></a>
</div>
<div class="descr">
Failed to get available update data. To ensure the proper functioning of your application, update now.
</div>
</div>
</div>
<div class="item">
<i class="notification-icon icmn-bubbles5"></i>
<div class="inner">
<div class="title">
<span class="pull-right">30 min ago</span>
<a href="javascript: void(0);">Inbox Message</a>
</div>
<div class="descr">
From: <a href="javascript: void(0);">David Bowie</a>
</div>
</div>
</div>
<div class="item">
<i class="notification-icon icmn-pie-chart2"></i>
<div class="inner">
<div class="title">
<span class="pull-right">now</span>
<a href="javascript: void(0);">Update Status: <span class="label label-primary font-weight-700">New</span></a>
</div>
<div class="descr">
Failed to get available update data. To ensure the proper functioning of your application, update now.
</div>
</div>
</div>
<div class="item">
<i class="notification-icon icmn-books"></i>
<div class="inner">
<div class="title">
<span class="pull-right">24 min ago</span>
<a href="javascript: void(0);">Income: <span class="label label-warning font-weight-700">$299.00</span></a>
</div>
<div class="descr">
Failed to get available update data. To ensure the proper functioning of your application, update now.
</div>
</div>
</div>
<div class="item">
<i class="notification-icon icmn-cog util-spin-delayed-pseudo"></i>
<div class="inner">
<div class="title">
<span class="pull-right">30 min ago</span>
<a href="javascript: void(0);">Inbox Message</a>
</div>
<div class="descr">
From: <a href="javascript: void(0);">David Bowie</a>
</div>
</div>
</div>
</div>
</ul>
</div>
</div>
<div class="menu-info-block">
<div class="left">
<div class="header-buttons">
<div class="dropdown">
<a href="javascript: void(0);" class="dropdown-toggle dropdown-inline-button" data-toggle="dropdown" aria-expanded="false">
<i class="dropdown-inline-button-icon icmn-folder-open"></i>
<span class="hidden-lg-down">Issues History</span>
<span class="caret"></span>
</a>
<ul class="dropdown-menu" aria-labelledby="" role="menu">
<a class="dropdown-item" href="javascript:void(0)">Current search</a>
<a class="dropdown-item" href="javascript:void(0)">Search for issues</a>
<div class="dropdown-divider"></div>
<div class="dropdown-header">Opened</div>
<a class="dropdown-item" href="javascript:void(0)"><i class="dropdown-icon icmn-checkmark"></i> CLNUI-253 Project implemen...</a>
<a class="dropdown-item" href="javascript:void(0)"><i class="dropdown-icon icmn-checkmark"></i> CLNUI-234 Active history iss...</a>
<a class="dropdown-item" href="javascript:void(0)"><i class="dropdown-icon icmn-clock"></i> CLNUI-424 Ionicons intergrat...</a>
<a class="dropdown-item" href="javascript:void(0)">More...</a>
<div class="dropdown-divider"></div>
<div class="dropdown-header">Filters</div>
<a class="dropdown-item" href="javascript:void(0)">My open issues</a>
<a class="dropdown-item" href="javascript:void(0)">Reported by me</a>
<div class="dropdown-divider"></div>
<a class="dropdown-item" href="javascript:void(0)">Import issues from CSV</a>
<div class="dropdown-divider"></div>
<a class="dropdown-item" href="javascript:void(0)"><i class="dropdown-icon icmn-cog"></i> Settings</a>
</ul>
</div>
<div class="dropdown">
<a href="javascript: void(0);" class="dropdown-toggle dropdown-inline-button" data-toggle="dropdown" aria-expanded="false">
<i class="dropdown-inline-button-icon icmn-database"></i>
<span class="hidden-lg-down">Dashboards</span>
<span class="caret"></span>
</a>
<ul class="dropdown-menu" aria-labelledby="" role="menu">
<div class="dropdown-header">Active</div>
<a class="dropdown-item" href="javascript:void(0)">Project Management</a>
<a class="dropdown-item" href="javascript:void(0)">User Inetrface Development</a>
<a class="dropdown-item" href="javascript:void(0)">Documentation</a>
<div class="dropdown-header">Inactive</div>
<a class="dropdown-item" href="javascript:void(0)">Marketing</a>
<div class="dropdown-divider"></div>
<a class="dropdown-item" href="javascript:void(0)"><i class="dropdown-icon icmn-cog"></i> Settings</a>
</ul>
</div>
</div>
</div>
<div class="left hidden-md-down">
<div class="example-top-menu-chart">
<span class="title">Income:</span>
<span class="chart" id="topMenuChart">1,3,2,0,3,1,2,3,5,2</span>
<span class="count">425.00 USD</span>
<!-- Top Menu Chart Script -->
<script>
$(function () {
var topMenuChart = $("#topMenuChart").peity("bar", {
fill: ['#01a8fe'],
height: 22,
width: 44
});
setInterval(function() {
var random = Math.round(Math.random() * 10);
var values = topMenuChart.text().split(",");
values.shift();
values.push(random);
topMenuChart.text(values.join(",")).change()
}, 1000);
});
</script>
<!-- Top Menu Chart Script -->
</div>
</div>
<div class="right hidden-lg-down margin-left-20">
<div class="search-block">
<div class="form-input-icon form-input-icon-right">
<i class="icmn-search"></i>
<input type="text" class="form-control form-control-sm form-control-rounded" placeholder="Search...">
<button type="submit" class="search-block-submit "></button>
</div>
</div>
</div>
<div class="right example-buy-btn hidden-xs-down">
<a href="https://themeforest.net/item/clean-ui-premium-bootstrap-4-admin-template-angular-starter-kit/16678285?s_rank=4&ref=mediatec_software" target="_blank" class="btn btn-success-outline btn-rounded">
Buy Now 25$
</a>
</div>
</div>
</div>
</nav>
<section class="page-content" ng-view></section>
<div class="cwt__footer" ng-class="{'visible-footer': showFooter}">
<div class="cwt__footer__top">
<div class="row">
<div class="col-lg-6">
<div class="cwt__footer__title cwt__footer__title--light">
Check Out Preselected Demos
</div>
<div class="row">
<div class="col-lg-6">
<ul class="list-unstyled">
<li><a target="_blank" href="http://cleanuitemplate.com/version_angular/index.html#/dashboards/alpha" class="cwt__footer__link">Vertical Menu (Default)</a></li>
<li><a target="_blank" href="http://cleanuitemplate.com/version_angular/index_menu_shadow_superclean.html#/ecommerce/products-catalog" class="cwt__footer__link">Ecommerce Version</a></li>
<li><a target="_blank" href="http://cleanuitemplate.com/version_angular/index_horizontal_boxed_container.html#/dashboards/alpha" class="cwt__footer__link">Horizontal Menu + Boxed Container</a></li>
<li><a target="_blank" href="http://cleanuitemplate.com/version_angular/index_iconbar.html#/dashboards/alpha" class="cwt__footer__link">Iconbar Vertical Menu</a></li>
<li><a target="_blank" href="http://cleanuitemplate.com/version_angular/index_inverse.html#/dashboards/alpha" class="cwt__footer__link">Inverse Color Scheme</a></li>
</ul>
</div>
<div class="col-lg-6">
<ul class="list-unstyled">
<li><a target="_blank" href="http://cleanuitemplate.com/version_angular/index_menu_shadow_superclean.html#/dashboards/alpha" class="cwt__footer__link">Super Clean Mode + Menu Shadow</a></li>
<li><a target="_blank" href="http://cleanuitemplate.com/version_angular/index_horizontal.html#/dashboards/alpha" class="cwt__footer__link">Horizontal Menu</a></li>
<li><a target="_blank" href="http://cleanuitemplate.com/version_angular/index_horizontal_compact.html#/dashboards/alpha" class="cwt__footer__link">Compact Horizontal Menu</a></li>
<li><a target="_blank" href="http://cleanuitemplate.com/version_angular/index_boxed.html#/dashboards/alpha" class="cwt__footer__link">Vertical Menu + Boxed</a></li>
<li><a target="_blank" href="http://cleanuitemplate.com/version_angular/index_horizontal_boxed.html#/dashboards/alpha" class="cwt__footer__link">Horizontal Menu + Boxed</a></li>
</ul>
</div>
</div>
</div>
<div class="col-lg-6">
<div class="cwt__footer__title">
Clean UI Admin Template
</div>
<div class="cwt__footer__description">
<p>Clean UI – a modern professional admin template, based on Bootstrap 4
framework. Clean UI is a powerful and super flexible tool, which suits best for any
kind of web application: Web Applications; CRM; CMS; Admin Panels; Dashboards; etc.
Clean UI is fully responsive, which means that it looks perfect on mobiles and
tablets</p>
<p>Clean UI is fully based on SASS pre-processor, includes 50+ commented SASS files.
Each file corresponds to a single component, layout, page, plugin or extension –
so you can easily find necessary piece of code and edit it for your needs.
The package includes both normal and minified CSS files, compiled from SASS</p>
</div>
</div>
</div>
</div>
<div class="cwt__footer__bottom">
<div class="row">
<div class="col-md-4">
<a href="https://themeforest.net/item/clean-ui-premium-bootstrap-4-admin-template-angular-starter-kit/16678285?s_rank=4&ref=mediatec_software" target="_blank" class="btn btn-primary">
Buy Now 25$
</a>
</div>
<div class="col-md-8">
<div class="cwt__footer__company">
<img class="cwt__footer__company-logo" src="../assets/common/img/temp/mediatec.png" target="_blank" title="Mediatec Software">
<span>
© 2016 <a href="http://mediatec.org/" class="cwt__footer__link" target="_blank">Mediatec Software</a>
<br>
All rights reserved
</span>
</div>
</div>
</div>
</div>
</div>
<div class="main-backdrop"><!-- --></div>
</body>
</html>
|
RanjithkumarAnkam/BC
|
web/build/version_angular/index_boxed.html
|
HTML
|
bsd-3-clause
| 59,115 |
<!doctype html>
<head>
<script src = "/resources/testharness.js"></script>
<script src = "/resources/testharnessreport.js"></script>
<script src = "/serviceworker/resources/test-helpers.js"></script>
<script src = "/serviceworker/resources/fetch-test-options.js"></script>
<script src = "../resources/fetch-test-helpers.js"></script>
</head>
<body>
<script>
function start(t) {
var script = document.createElement('script');
script.src = '../script-tests/block-mixed-content.js?-base-https';
script.addEventListener(
'error',
function() { unreached_rejection(t); });
script.addEventListener(
'load',
function() { t.done(); });
document.body.appendChild(script);
}
function init() {
return Promise.resolve();
}
</script>
<script src = "../resources/init.js"></script>
</body>
|
XiaosongWei/blink-crosswalk
|
LayoutTests/http/tests/fetch/window/block-mixed-content-base-https.html
|
HTML
|
bsd-3-clause
| 803 |
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>ORKSpatialSpanTargetState Constants Reference</title>
<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
<meta name="generator" content="appledoc 2.2.1 (build 1334)">
</head>
<body class="appledoc">
<header>
<div class="container" class="hide-in-xcode">
<h1 id="library-title">
<a href="../index.html">ResearchKit </a>
</h1>
<p id="developer-home">
<a href="../index.html">ResearchKit</a>
</p>
</div>
</header>
<aside>
<div class="container">
<nav>
<ul id="header-buttons" role="toolbar">
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
<li id="on-this-page" role="navigation">
<label>
On This Page
<div class="chevron">
<div class="chevy chevron-left"></div>
<div class="chevy chevron-right"></div>
</div>
<select id="jump-to">
<option value="top">Jump To…</option>
</select>
</label>
</li>
</ul>
</nav>
</div>
</aside>
<article>
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">ORKSpatialSpanTargetState Constants Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Declared in</th>
<td>ORKSpatialSpanGameState.h</td>
</tr>
</tbody></table></div>
<h3 class="subsubtitle method-title">ORKSpatialSpanTargetState</h3>
<div class="section">
<!-- display enum values -->
<h4 class="method-subtitle">Definition</h4>
<code>typedef NS_ENUM(NSInteger, ORKSpatialSpanTargetState ) {<br>
<a href="">ORKSpatialSpanTargetStateQuiescent</a>,<br>
<a href="">ORKSpatialSpanTargetStateActive</a>,<br>
<a href="">ORKSpatialSpanTargetStateCorrect</a>,<br>
<a href="">ORKSpatialSpanTargetStateIncorrect</a>,<br>
};</code>
</div>
<div class="section section-methods">
<h4 class="method-subtitle">Constants</h4>
<dl class="termdef">
<dt><a name="" title="ORKSpatialSpanTargetStateQuiescent"></a><code>ORKSpatialSpanTargetStateQuiescent</code></dt>
<dd>
<p>
Declared In <code class="declared-in-ref">ORKSpatialSpanGameState.h</code>.
</p>
</dd>
<dt><a name="" title="ORKSpatialSpanTargetStateActive"></a><code>ORKSpatialSpanTargetStateActive</code></dt>
<dd>
<p>
Declared In <code class="declared-in-ref">ORKSpatialSpanGameState.h</code>.
</p>
</dd>
<dt><a name="" title="ORKSpatialSpanTargetStateCorrect"></a><code>ORKSpatialSpanTargetStateCorrect</code></dt>
<dd>
<p>
Declared In <code class="declared-in-ref">ORKSpatialSpanGameState.h</code>.
</p>
</dd>
<dt><a name="" title="ORKSpatialSpanTargetStateIncorrect"></a><code>ORKSpatialSpanTargetStateIncorrect</code></dt>
<dd>
<p>
Declared In <code class="declared-in-ref">ORKSpatialSpanGameState.h</code>.
</p>
</dd>
</dl>
</div>
</main>
<footer>
<div class="footer-copyright">
<p class="copyright">Copyright © 2018 ResearchKit. All rights reserved. Updated: 2018-07-23</p>
<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
</div>
</footer>
</div>
</div>
</article>
<script src="../js/script.js"></script>
</body>
</html>
|
jeremiahyan/ResearchKit
|
docs/org.researchkit.ResearchKit.docset/Contents/Resources/Documents/Constants/ORKSpatialSpanTargetState.html
|
HTML
|
bsd-3-clause
| 4,481 |
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>The Proactor Design Pattern: Concurrency Without Threads</title>
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../core.html" title="Core Concepts and Functionality">
<link rel="prev" href="basics.html" title="Basic Boost.Asio Anatomy">
<link rel="next" href="threads.html" title="Threads and Boost.Asio">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basics.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../core.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="threads.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.overview.core.async"></a><a class="link" href="async.html" title="The Proactor Design Pattern: Concurrency Without Threads">The Proactor Design
Pattern: Concurrency Without Threads</a>
</h4></div></div></div>
<p>
The Boost.Asio library offers side-by-side support for synchronous and
asynchronous operations. The asynchronous support is based on the Proactor
design pattern <a class="link" href="async.html#boost_asio.overview.core.async.references">[POSA2]</a>.
The advantages and disadvantages of this approach, when compared to a synchronous-only
or Reactor approach, are outlined below.
</p>
<h6>
<a name="boost_asio.overview.core.async.h0"></a>
<span class="phrase"><a name="boost_asio.overview.core.async.proactor_and_boost_asio"></a></span><a class="link" href="async.html#boost_asio.overview.core.async.proactor_and_boost_asio">Proactor
and Boost.Asio</a>
</h6>
<p>
Let us examine how the Proactor design pattern is implemented in Boost.Asio,
without reference to platform-specific details.
</p>
<p>
<span class="inlinemediaobject"><img src="../../proactor.png" alt="proactor"></span>
</p>
<p>
<span class="bold"><strong>Proactor design pattern (adapted from [POSA2])</strong></span>
</p>
<p>
— Asynchronous Operation
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Defines an operation that is executed asynchronously, such as an asynchronous
read or write on a socket.
</p></blockquote></div>
<p>
— Asynchronous Operation Processor
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Executes asynchronous operations and queues events on a completion event
queue when operations complete. From a high-level point of view, services
like <code class="computeroutput"><span class="identifier">stream_socket_service</span></code>
are asynchronous operation processors.
</p></blockquote></div>
<p>
— Completion Event Queue
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Buffers completion events until they are dequeued by an asynchronous
event demultiplexer.
</p></blockquote></div>
<p>
— Completion Handler
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Processes the result of an asynchronous operation. These are function
objects, often created using <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">bind</span></code>.
</p></blockquote></div>
<p>
— Asynchronous Event Demultiplexer
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Blocks waiting for events to occur on the completion event queue, and
returns a completed event to its caller.
</p></blockquote></div>
<p>
— Proactor
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Calls the asynchronous event demultiplexer to dequeue events, and dispatches
the completion handler (i.e. invokes the function object) associated
with the event. This abstraction is represented by the <code class="computeroutput"><span class="identifier">io_service</span></code> class.
</p></blockquote></div>
<p>
— Initiator
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Application-specific code that starts asynchronous operations. The initiator
interacts with an asynchronous operation processor via a high-level interface
such as <code class="computeroutput"><span class="identifier">basic_stream_socket</span></code>,
which in turn delegates to a service like <code class="computeroutput"><span class="identifier">stream_socket_service</span></code>.
</p></blockquote></div>
<h6>
<a name="boost_asio.overview.core.async.h1"></a>
<span class="phrase"><a name="boost_asio.overview.core.async.implementation_using_reactor"></a></span><a class="link" href="async.html#boost_asio.overview.core.async.implementation_using_reactor">Implementation
Using Reactor</a>
</h6>
<p>
On many platforms, Boost.Asio implements the Proactor design pattern in
terms of a Reactor, such as <code class="computeroutput"><span class="identifier">select</span></code>,
<code class="computeroutput"><span class="identifier">epoll</span></code> or <code class="computeroutput"><span class="identifier">kqueue</span></code>. This implementation approach
corresponds to the Proactor design pattern as follows:
</p>
<p>
— Asynchronous Operation Processor
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
A reactor implemented using <code class="computeroutput"><span class="identifier">select</span></code>,
<code class="computeroutput"><span class="identifier">epoll</span></code> or <code class="computeroutput"><span class="identifier">kqueue</span></code>. When the reactor indicates
that the resource is ready to perform the operation, the processor executes
the asynchronous operation and enqueues the associated completion handler
on the completion event queue.
</p></blockquote></div>
<p>
— Completion Event Queue
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
A linked list of completion handlers (i.e. function objects).
</p></blockquote></div>
<p>
— Asynchronous Event Demultiplexer
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
This is implemented by waiting on an event or condition variable until
a completion handler is available in the completion event queue.
</p></blockquote></div>
<h6>
<a name="boost_asio.overview.core.async.h2"></a>
<span class="phrase"><a name="boost_asio.overview.core.async.implementation_using_windows_overlapped_i_o"></a></span><a class="link" href="async.html#boost_asio.overview.core.async.implementation_using_windows_overlapped_i_o">Implementation
Using Windows Overlapped I/O</a>
</h6>
<p>
On Windows NT, 2000 and XP, Boost.Asio takes advantage of overlapped I/O
to provide an efficient implementation of the Proactor design pattern.
This implementation approach corresponds to the Proactor design pattern
as follows:
</p>
<p>
— Asynchronous Operation Processor
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
This is implemented by the operating system. Operations are initiated
by calling an overlapped function such as <code class="computeroutput"><span class="identifier">AcceptEx</span></code>.
</p></blockquote></div>
<p>
— Completion Event Queue
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
This is implemented by the operating system, and is associated with an
I/O completion port. There is one I/O completion port for each <code class="computeroutput"><span class="identifier">io_service</span></code> instance.
</p></blockquote></div>
<p>
— Asynchronous Event Demultiplexer
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Called by Boost.Asio to dequeue events and their associated completion
handlers.
</p></blockquote></div>
<h6>
<a name="boost_asio.overview.core.async.h3"></a>
<span class="phrase"><a name="boost_asio.overview.core.async.advantages"></a></span><a class="link" href="async.html#boost_asio.overview.core.async.advantages">Advantages</a>
</h6>
<p>
— Portability.
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Many operating systems offer a native asynchronous I/O API (such as overlapped
I/O on <span class="emphasis"><em>Windows</em></span>) as the preferred option for developing
high performance network applications. The library may be implemented
in terms of native asynchronous I/O. However, if native support is not
available, the library may also be implemented using synchronous event
demultiplexors that typify the Reactor pattern, such as <span class="emphasis"><em>POSIX</em></span>
<code class="computeroutput"><span class="identifier">select</span><span class="special">()</span></code>.
</p></blockquote></div>
<p>
— Decoupling threading from concurrency.
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Long-duration operations are performed asynchronously by the implementation
on behalf of the application. Consequently applications do not need to
spawn many threads in order to increase concurrency.
</p></blockquote></div>
<p>
— Performance and scalability.
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Implementation strategies such as thread-per-connection (which a synchronous-only
approach would require) can degrade system performance, due to increased
context switching, synchronisation and data movement among CPUs. With
asynchronous operations it is possible to avoid the cost of context switching
by minimising the number of operating system threads — typically a limited
resource — and only activating the logical threads of control that have
events to process.
</p></blockquote></div>
<p>
— Simplified application synchronisation.
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Asynchronous operation completion handlers can be written as though they
exist in a single-threaded environment, and so application logic can
be developed with little or no concern for synchronisation issues.
</p></blockquote></div>
<p>
— Function composition.
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Function composition refers to the implementation of functions to provide
a higher-level operation, such as sending a message in a particular format.
Each function is implemented in terms of multiple calls to lower-level
read or write operations.
</p></blockquote></div>
<div class="blockquote"><blockquote class="blockquote"><p>
For example, consider a protocol where each message consists of a fixed-length
header followed by a variable length body, where the length of the body
is specified in the header. A hypothetical read_message operation could
be implemented using two lower-level reads, the first to receive the
header and, once the length is known, the second to receive the body.
</p></blockquote></div>
<div class="blockquote"><blockquote class="blockquote"><p>
To compose functions in an asynchronous model, asynchronous operations
can be chained together. That is, a completion handler for one operation
can initiate the next. Starting the first call in the chain can be encapsulated
so that the caller need not be aware that the higher-level operation
is implemented as a chain of asynchronous operations.
</p></blockquote></div>
<div class="blockquote"><blockquote class="blockquote"><p>
The ability to compose new operations in this way simplifies the development
of higher levels of abstraction above a networking library, such as functions
to support a specific protocol.
</p></blockquote></div>
<h6>
<a name="boost_asio.overview.core.async.h4"></a>
<span class="phrase"><a name="boost_asio.overview.core.async.disadvantages"></a></span><a class="link" href="async.html#boost_asio.overview.core.async.disadvantages">Disadvantages</a>
</h6>
<p>
— Program complexity.
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
It is more difficult to develop applications using asynchronous mechanisms
due to the separation in time and space between operation initiation
and completion. Applications may also be harder to debug due to the inverted
flow of control.
</p></blockquote></div>
<p>
— Memory usage.
</p>
<div class="blockquote"><blockquote class="blockquote"><p>
Buffer space must be committed for the duration of a read or write operation,
which may continue indefinitely, and a separate buffer is required for
each concurrent operation. The Reactor pattern, on the other hand, does
not require buffer space until a socket is ready for reading or writing.
</p></blockquote></div>
<h6>
<a name="boost_asio.overview.core.async.h5"></a>
<span class="phrase"><a name="boost_asio.overview.core.async.references"></a></span><a class="link" href="async.html#boost_asio.overview.core.async.references">References</a>
</h6>
<p>
[POSA2] D. Schmidt et al, <span class="emphasis"><em>Pattern Oriented Software Architecture,
Volume 2</em></span>. Wiley, 2000.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2014 Christopher M. Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basics.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../core.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="threads.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
rkq/cxxexp
|
third-party/src/boost_1_56_0/doc/html/boost_asio/overview/core/async.html
|
HTML
|
mit
| 16,554 |
<a href='https://github.com/angular/angular.js/edit/v1.3.x/src/auto/injector.js?message=docs(angular.injector)%3A%20describe%20your%20change...#L3' class='improve-docs btn btn-primary'><i class="glyphicon glyphicon-edit"> </i>Improve this Doc</a>
<a href='https://github.com/angular/angular.js/tree/v1.3.3/src/auto/injector.js#L3' class='view-source pull-right btn btn-primary'>
<i class="glyphicon glyphicon-zoom-in"> </i>View Source
</a>
<header class="api-profile-header">
<h1 class="api-profile-header-heading">angular.injector</h1>
<ol class="api-profile-header-structure naked-list step-list">
<li>
- function in module <a href="api/ng">ng</a>
</li>
</ol>
</header>
<div class="api-profile-description">
<p>Creates an injector object that can be used for retrieving services as well as for
dependency injection (see <a href="guide/di">dependency injection</a>).</p>
</div>
<div>
<h2 id="usage">Usage</h2>
<p><code>angular.injector(modules);</code></p>
<section class="api-section">
<h3>Arguments</h3>
<table class="variables-matrix input-arguments">
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Details</th>
</tr>
</thead>
<tbody>
<tr>
<td>
modules
</td>
<td>
<a href="" class="label type-hint type-hint-array">Array.<string|Function></a>
</td>
<td>
<p>A list of module functions or their aliases. See
<a href="api/ng/function/angular.module"><code>angular.module</code></a>. The <code>ng</code> module must be explicitly added.</p>
</td>
</tr>
</tbody>
</table>
</section>
<h3>Returns</h3>
<table class="variables-matrix return-arguments">
<tr>
<td><a href="" class="label type-hint type-hint-injector">injector</a></td>
<td><p>Injector object. See <a href="api/auto/service/$injector">$injector</a>.</p>
</td>
</tr>
</table>
<h2 id="example">Example</h2><p>Typical usage</p>
<pre><code class="lang-js">// create an injector
var $injector = angular.injector(['ng']);
// use the injector to kick off your application
// use the type inference to auto inject arguments, or use implicit injection
$injector.invoke(function($rootScope, $compile, $document) {
$compile($document)($rootScope);
$rootScope.$digest();
});
</code></pre>
<p>Sometimes you want to get access to the injector of a currently running Angular app
from outside Angular. Perhaps, you want to inject and compile some markup after the
application has been bootstrapped. You can do this using the extra <code>injector()</code> added
to JQuery/jqLite elements. See <a href="api/ng/function/angular.element"><code>angular.element</code></a>.</p>
<p><em>This is fairly rare but could be the case if a third party library is injecting the
markup.</em></p>
<p>In the following example a new block of HTML containing a <code>ng-controller</code>
directive is added to the end of the document body by JQuery. We then compile and link
it into the current AngularJS scope.</p>
<pre><code class="lang-js">var $div = $('<div ng-controller="MyCtrl">{{content.label}}</div>');
$(document.body).append($div);
angular.element(document).injector().invoke(function($compile) {
var scope = angular.element($div).scope();
$compile($div)(scope);
});
</code></pre>
</div>
|
viral810/ngSimpleCMS
|
web/bundles/sunraangular/js/angular/angular-1.3.3/docs/partials/api/ng/function/angular.injector.html
|
HTML
|
mit
| 3,457 |
<article class="container-fluid">
<h3 class="page-header">
<b>Edit Address:</b> {{addressEdit.addressName}}
</h3>
<form name="AddressEditForm" ng-submit="addressEdit.Submit()">
<div class="row">
<div class="col-sm-6 form-group">
<label for="addressIDInput">Address ID</label>
<input id="addressIDInput" type="text" class="form-control" ng-model="addressEdit.address.ID"/>
</div>
<div class="col-sm-6 form-group">
<label for="addressNameInput">Address Name</label>
<input id="addressNameInput" type="text" class="form-control" ng-model="addressEdit.address.AddressName" required/>
</div>
</div>
<div class="row">
<div class="col-sm-12 form-group">
<label for="addressCompanyNameInput">Company Name</label>
<input id="addressCompanyNameInput" type="text" class="form-control" ng-model="addressEdit.address.CompanyName"/>
</div>
</div>
<div class="row">
<div class="col-sm-6 form-group">
<label for="addressFirstNameInput">First Name</label>
<input id="addressFirstNameInput" type="text" class="form-control" ng-model="addressEdit.address.FirstName"/>
</div>
<div class="col-sm-6 form-group">
<label for="addressLastNameInput">Last Name</label>
<input id="addressLastNameInput" type="text" class="form-control" ng-model="addressEdit.address.LastName"/>
</div>
</div>
<div class="row">
<div class="col-sm-6 form-group">
<label for="addressStreet1Input">Street 1</label>
<input id="addressStreet1Input" type="text" class="form-control" ng-model="addressEdit.address.Street1" required/>
</div>
<div class="col-sm-6 form-group">
<label for="addressStreet2Input">Street 2</label>
<input id="addressStreet2Input" type="text" class="form-control" ng-model="addressEdit.address.Street2"/>
</div>
</div>
<div class="row">
<div class="col-sm-6 form-group">
<label for="addressCityInput">City</label>
<input id="addressCityInput" type="text" class="form-control" ng-model="addressEdit.address.City" required/>
</div>
<div class="col-sm-3 form-group">
<label for="addressStateInput">State</label>
<input id="addressStateInput" type="text" class="form-control" ng-model="addressEdit.address.State" required/>
</div>
<div class="col-sm-3 form-group">
<label for="addressZipInput">Zip</label>
<input id="addressZipInput" type="text" class="form-control" ng-model="addressEdit.address.Zip" required/>
</div>
</div>
<div class="row">
<div class="col-sm-6 form-group">
<label for="addressCountryInput">Country</label>
<input id="addressCountryInput" type="text" class="form-control" ng-model="addressEdit.address.Country" maxlength="2" required/>
</div>
<div class="col-sm-6 form-group">
<label for="addressPhoneInput">Phone Number</label>
<input id="addressPhoneInput" type="text" class="form-control" ng-model="addressEdit.address.Phone"/>
</div>
</div>
<div class="form-group">
<button type="submit" class="btn btn-primary" ng-disabled="AddressEditForm.$invalid">Save</button>
<button type="button" class="btn btn-default" ui-sref="^">Cancel</button>
<button type="button" class="btn btn-default" ng-click="addressEdit.Delete()"><i class="fa fa-trash text-danger"></i></button>
</div>
<!--TODO: The Address Edit state should also include Address Assignments-->
</form>
</article>
|
robertsoniv/FedExScenario2Buyer
|
src/app/addresses/templates/addressEdit.tpl.html
|
HTML
|
mit
| 3,752 |
---
layout: v2
title: Documentation
bodyclass: api-page
---
<h2>API Reference</h2>
<p>This reference reflects <strong>Leaflet 1.1.0</strong>. Check <a href='reference-versions.html'>this list</a> if you are using a different version of Leaflet.</p>
<div id="toc" class="clearfix">
<div class="toc-col map-col">
<h4>Map</h4>
<ul>
<li><a href="#map-example">Usage example</a></li>
<li><a href="#map-factory">Creation</a></li>
<li><a href="#map-option">Options</a></li>
<li><a href="#map-event">Events</a></li>
</ul>
<h4>Map Methods</h4>
<ul>
<li><a href="#map-methods-for-modifying-map-state">Modifying map state</a></li>
<li><a href="#map-methods-for-getting-map-state">Getting map state</a></li>
<li><a href="#map-methods-for-layers-and-controls">Layers and controls</a></li>
<li><a href="#map-conversion-methods">Conversion methods</a></li>
<li><a href="#map-other-methods">Other methods</a></li>
</ul>
<h4>Map Misc</h4>
<ul>
<li><a href="#map-property">Properties</a></li>
<li><a href="#map-pane">Panes</a></li>
</ul>
</div>
<div class="toc-col">
<h4>UI Layers</h4>
<ul>
<li><a href="#marker">Marker</a></li>
<li><a href="#popup">Popup</a></li>
<li><a href="#tooltip">Tooltip</a></li>
</ul>
<h4>Raster Layers</h4>
<ul>
<li><a href="#tilelayer">TileLayer</a></li>
<li><a href="#tilelayer-wms">TileLayer.WMS</a></li>
<li><a href="#imageoverlay">ImageOverlay</a></li>
<li><a href="#videooverlay">VideoOverlay</a></li>
</ul>
<h4>Vector Layers</h4>
<ul>
<li><a href="#path">Path</a></li>
<li><a href="#polyline">Polyline</a></li>
<li><a href="#polygon">Polygon</a></li>
<li><a href="#rectangle">Rectangle</a></li>
<li><a href="#circle">Circle</a></li>
<li><a href="#circlemarker">CircleMarker</a></li>
<li><a href="#svg">SVG</a></li>
<li><a href="#canvas">Canvas</a></li>
</ul>
</div>
<div class="toc-col">
<h4>Other Layers</h4>
<ul>
<li><a href="#layergroup">LayerGroup</a></li>
<li><a href="#featuregroup">FeatureGroup</a></li>
<li><a href="#geojson">GeoJSON</a></li>
<li><a href="#gridlayer">GridLayer</a></li>
</ul>
<h4>Basic Types</h4>
<ul>
<li><a href="#latlng">LatLng</a></li>
<li><a href="#latlngbounds">LatLngBounds</a></li>
<li><a href="#point">Point</a></li>
<li><a href="#bounds">Bounds</a></li>
<li><a href="#icon">Icon</a></li>
<li><a href="#divicon">DivIcon</a></li>
</ul>
<h4>Controls</h4>
<ul>
<li><a href="#control-zoom">Zoom</a></li>
<li><a href="#control-attribution">Attribution</a></li>
<li><a href="#control-layers">Layers</a></li>
<li><a href="#control-scale">Scale</a></li>
</ul>
</div>
<div class="toc-col">
<!-- <h4>Shared Methods</h4> -->
<!-- <ul> -->
<!-- <li><a href="#evented">Event</a></li> -->
<!-- <li><a href="#layers">Layer</a></li> -->
<!-- <li><a href="#popup">Popup</a></li> -->
<!-- </ul> -->
<h4>Utility</h4>
<ul>
<li><a href="#browser">Browser</a></li>
<li><a href="#util">Util</a></li>
<li><a href="#transformation">Transformation</a></li>
<li><a href="#lineutil">LineUtil</a></li>
<li><a href="#polyutil">PolyUtil</a></li>
</ul>
<h4>DOM Utility</h4>
<ul>
<li><a href="#domevent">DomEvent</a></li>
<li><a href="#domutil">DomUtil</a></li>
<li><a href="#posanimation">PosAnimation</a></li>
<li><a href="#draggable">Draggable</a></li>
</ul>
</div>
<div class="toc-col last-col">
<h4>Base Classes</h4>
<ul>
<li><a href="#class">Class</a></li>
<li><a href="#evented">Evented</a></li>
<li><a href="#layer">Layer</a></li>
<li><a href="#interactive-layer">Interactive layer</a></li>
<li><a href="#control">Control</a></li>
<li><a href="#handler">Handler</a></li>
<!--<li><a class="nodocs" href="#">IFeature</a></li>-->
<li><a href="#projection">Projection</a></li>
<li><a href="#crs">CRS</a></li>
<li><a href="#renderer">Renderer</a></li>
</ul>
<h4>Misc</h4>
<ul>
<li><a href="#event-objects">Event objects</a></li>
<li><a href="#global-switches">global switches</a></li>
<li><a href="#noconflict">noConflict</a></li>
<li><a href="#version">version</a></li>
</ul>
</div>
</div>
<h2 id='map'>Map</h2><p>The central class of the API — it is used to create a map on a page and manipulate it.</p>
<section>
<h3 id='map-example'>Usage example</h3>
<section >
<pre><code class="lang-js">// initialize the map on the "map" div with a given center and zoom
var map = L.map('map', {
center: [51.505, -0.09],
zoom: 13
});
</code></pre>
</section>
</section><section>
<h3 id='map-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-l-map'>
<td><code><b>L.map</b>(<nobr><String></nobr> <i>id</i>, <nobr><Map options></nobr> <i>options?</i>)</nobr></code></td>
<td>Instantiates a map object given the DOM ID of a <code><div></code> element
and optionally an object literal with <code>Map options</code>.</td>
</tr>
<tr id='map-l-map'>
<td><code><b>L.map</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><Map options></nobr> <i>options?</i>)</nobr></code></td>
<td>Instantiates a map object given an instance of a <code><div></code> HTML element
and optionally an object literal with <code>Map options</code>.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='map-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-prefercanvas'>
<td><code><b>preferCanvas</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>Whether <a href="#path"><code>Path</code></a>s should be rendered on a <a href="#canvas"><code>Canvas</code></a> renderer.
By default, all <code>Path</code>s are rendered in a <a href="#svg"><code>SVG</code></a> renderer.</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-control-options'>Control options</h4>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-attributioncontrol'>
<td><code><b>attributionControl</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether a <a href="#control-attribution">attribution control</a> is added to the map by default.</td>
</tr>
<tr id='map-zoomcontrol'>
<td><code><b>zoomControl</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether a <a href="#control-zoom">zoom control</a> is added to the map by default.</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-interaction-options'>Interaction Options</h4>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-closepopuponclick'>
<td><code><b>closePopupOnClick</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Set it to <code>false</code> if you don't want popups to close when user clicks the map.</td>
</tr>
<tr id='map-zoomsnap'>
<td><code><b>zoomSnap</b></code></td>
<td><code>Number</code>
<td><code>1</code></td>
<td>Forces the map's zoom level to always be a multiple of this, particularly
right after a <a href="#map-fitbounds"><code>fitBounds()</code></a> or a pinch-zoom.
By default, the zoom level snaps to the nearest integer; lower values
(e.g. <code>0.5</code> or <code>0.1</code>) allow for greater granularity. A value of <code>0</code>
means the zoom level will not be snapped after <code>fitBounds</code> or a pinch-zoom.</td>
</tr>
<tr id='map-zoomdelta'>
<td><code><b>zoomDelta</b></code></td>
<td><code>Number</code>
<td><code>1</code></td>
<td>Controls how much the map's zoom level will change after a
<a href="#map-zoomin"><code>zoomIn()</code></a>, <a href="#map-zoomout"><code>zoomOut()</code></a>, pressing <code>+</code>
or <code>-</code> on the keyboard, or using the <a href="#control-zoom">zoom controls</a>.
Values smaller than <code>1</code> (e.g. <code>0.5</code>) allow for greater granularity.</td>
</tr>
<tr id='map-trackresize'>
<td><code><b>trackResize</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether the map automatically handles browser window resize to update itself.</td>
</tr>
<tr id='map-boxzoom'>
<td><code><b>boxZoom</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether the map can be zoomed to a rectangular area specified by
dragging the mouse while pressing the shift key.</td>
</tr>
<tr id='map-doubleclickzoom'>
<td><code><b>doubleClickZoom</b></code></td>
<td><code>Boolean|String</code>
<td><code>true</code></td>
<td>Whether the map can be zoomed in by double clicking on it and
zoomed out by double clicking while holding shift. If passed
<code>'center'</code>, double-click zoom will zoom to the center of the
view regardless of where the mouse was.</td>
</tr>
<tr id='map-dragging'>
<td><code><b>dragging</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether the map be draggable with mouse/touch or not.</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-map-state-options'>Map State Options</h4>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-crs'>
<td><code><b>crs</b></code></td>
<td><code><a href='#crs'>CRS</a></code>
<td><code>L.CRS.EPSG3857</code></td>
<td>The <a href="#crs">Coordinate Reference System</a> to use. Don't change this if you're not
sure what it means.</td>
</tr>
<tr id='map-center'>
<td><code><b>center</b></code></td>
<td><code><a href='#latlng'>LatLng</a></code>
<td><code>undefined</code></td>
<td>Initial geographic center of the map</td>
</tr>
<tr id='map-zoom'>
<td><code><b>zoom</b></code></td>
<td><code>Number</code>
<td><code>undefined</code></td>
<td>Initial map zoom level</td>
</tr>
<tr id='map-minzoom'>
<td><code><b>minZoom</b></code></td>
<td><code>Number</code>
<td><code>*</code></td>
<td>Minimum zoom level of the map.
If not specified and at least one <a href="#gridlayer"><code>GridLayer</code></a> or <a href="#tilelayer"><code>TileLayer</code></a> is in the map,
the lowest of their <code>minZoom</code> options will be used instead.</td>
</tr>
<tr id='map-maxzoom'>
<td><code><b>maxZoom</b></code></td>
<td><code>Number</code>
<td><code>*</code></td>
<td>Maximum zoom level of the map.
If not specified and at least one <a href="#gridlayer"><code>GridLayer</code></a> or <a href="#tilelayer"><code>TileLayer</code></a> is in the map,
the highest of their <code>maxZoom</code> options will be used instead.</td>
</tr>
<tr id='map-layers'>
<td><code><b>layers</b></code></td>
<td><code>Layer[]</code>
<td><code>[]</code></td>
<td>Array of layers that will be added to the map initially</td>
</tr>
<tr id='map-maxbounds'>
<td><code><b>maxBounds</b></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code>
<td><code>null</code></td>
<td>When this option is set, the map restricts the view to the given
geographical bounds, bouncing the user back if the user tries to pan
outside the view. To set the restriction dynamically, use
<a href="#map-setmaxbounds"><code>setMaxBounds</code></a> method.</td>
</tr>
<tr id='map-renderer'>
<td><code><b>renderer</b></code></td>
<td><code><a href='#renderer'>Renderer</a></code>
<td><code>*</code></td>
<td>The default method for drawing vector layers on the map. <a href="#svg"><code>L.SVG</code></a>
or <a href="#canvas"><code>L.Canvas</code></a> by default depending on browser support.</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-animation-options'>Animation Options</h4>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-zoomanimation'>
<td><code><b>zoomAnimation</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether the map zoom animation is enabled. By default it's enabled
in all browsers that support CSS3 Transitions except Android.</td>
</tr>
<tr id='map-zoomanimationthreshold'>
<td><code><b>zoomAnimationThreshold</b></code></td>
<td><code>Number</code>
<td><code>4</code></td>
<td>Won't animate zoom if the zoom difference exceeds this value.</td>
</tr>
<tr id='map-fadeanimation'>
<td><code><b>fadeAnimation</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether the tile fade animation is enabled. By default it's enabled
in all browsers that support CSS3 Transitions except Android.</td>
</tr>
<tr id='map-markerzoomanimation'>
<td><code><b>markerZoomAnimation</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether markers animate their zoom with the zoom animation, if disabled
they will disappear for the length of the animation. By default it's
enabled in all browsers that support CSS3 Transitions except Android.</td>
</tr>
<tr id='map-transform3dlimit'>
<td><code><b>transform3DLimit</b></code></td>
<td><code>Number</code>
<td><code>2^23</code></td>
<td>Defines the maximum size of a CSS translation transform. The default
value should not be changed unless a web browser positions layers in
the wrong place after doing a large <code>panBy</code>.</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-panning-inertia-options'>Panning Inertia Options</h4>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-inertia'>
<td><code><b>inertia</b></code></td>
<td><code>Boolean</code>
<td><code>*</code></td>
<td>If enabled, panning of the map will have an inertia effect where
the map builds momentum while dragging and continues moving in
the same direction for some time. Feels especially nice on touch
devices. Enabled by default unless running on old Android devices.</td>
</tr>
<tr id='map-inertiadeceleration'>
<td><code><b>inertiaDeceleration</b></code></td>
<td><code>Number</code>
<td><code>3000</code></td>
<td>The rate with which the inertial movement slows down, in pixels/second².</td>
</tr>
<tr id='map-inertiamaxspeed'>
<td><code><b>inertiaMaxSpeed</b></code></td>
<td><code>Number</code>
<td><code>Infinity</code></td>
<td>Max speed of the inertial movement, in pixels/second.</td>
</tr>
<tr id='map-easelinearity'>
<td><code><b>easeLinearity</b></code></td>
<td><code>Number</code>
<td><code>0.2</code></td>
<td></td>
</tr>
<tr id='map-worldcopyjump'>
<td><code><b>worldCopyJump</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>With this option enabled, the map tracks when you pan to another "copy"
of the world and seamlessly jumps to the original one so that all overlays
like markers and vector layers are still visible.</td>
</tr>
<tr id='map-maxboundsviscosity'>
<td><code><b>maxBoundsViscosity</b></code></td>
<td><code>Number</code>
<td><code>0.0</code></td>
<td>If <code>maxBounds</code> is set, this option will control how solid the bounds
are when dragging the map around. The default value of <code>0.0</code> allows the
user to drag outside the bounds at normal speed, higher values will
slow down map dragging outside bounds, and <code>1.0</code> makes the bounds fully
solid, preventing the user from dragging outside the bounds.</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-keyboard-navigation-options'>Keyboard Navigation Options</h4>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-keyboard'>
<td><code><b>keyboard</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Makes the map focusable and allows users to navigate the map with keyboard
arrows and <code>+</code>/<code>-</code> keys.</td>
</tr>
<tr id='map-keyboardpandelta'>
<td><code><b>keyboardPanDelta</b></code></td>
<td><code>Number</code>
<td><code>80</code></td>
<td>Amount of pixels to pan when pressing an arrow key.</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-mousewheel-options'>Mousewheel options</h4>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-scrollwheelzoom'>
<td><code><b>scrollWheelZoom</b></code></td>
<td><code>Boolean|String</code>
<td><code>true</code></td>
<td>Whether the map can be zoomed by using the mouse wheel. If passed <code>'center'</code>,
it will zoom to the center of the view regardless of where the mouse was.</td>
</tr>
<tr id='map-wheeldebouncetime'>
<td><code><b>wheelDebounceTime</b></code></td>
<td><code>Number</code>
<td><code>40</code></td>
<td>Limits the rate at which a wheel can fire (in milliseconds). By default
user can't zoom via wheel more often than once per 40 ms.</td>
</tr>
<tr id='map-wheelpxperzoomlevel'>
<td><code><b>wheelPxPerZoomLevel</b></code></td>
<td><code>Number</code>
<td><code>60</code></td>
<td>How many scroll pixels (as reported by <a href="#domevent-getwheeldelta">L.DomEvent.getWheelDelta</a>)
mean a change of one full zoom level. Smaller values will make wheel-zooming
faster (and vice versa).</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-touch-interaction-options'>Touch interaction options</h4>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-tap'>
<td><code><b>tap</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Enables mobile hacks for supporting instant taps (fixing 200ms click
delay on iOS/Android) and touch holds (fired as <code>contextmenu</code> events).</td>
</tr>
<tr id='map-taptolerance'>
<td><code><b>tapTolerance</b></code></td>
<td><code>Number</code>
<td><code>15</code></td>
<td>The max number of pixels a user can shift his finger during touch
for it to be considered a valid tap.</td>
</tr>
<tr id='map-touchzoom'>
<td><code><b>touchZoom</b></code></td>
<td><code>Boolean|String</code>
<td><code>*</code></td>
<td>Whether the map can be zoomed by touch-dragging with two fingers. If
passed <code>'center'</code>, it will zoom to the center of the view regardless of
where the touch events (fingers) were. Enabled for touch-capable web
browsers except for old Androids.</td>
</tr>
<tr id='map-bounceatzoomlimits'>
<td><code><b>bounceAtZoomLimits</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Set it to false if you don't want the map to zoom beyond min/max zoom
and then bounce back when pinch-zooming.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='map-event'>Events</h3>
<section class='collapsable'>
<h4 id='map-layer-events'>Layer events</h4>
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-baselayerchange'>
<td><code><b>baselayerchange</b>
<td><code><a href='#layerscontrolevent'>LayersControlEvent</a></code></td>
<td>Fired when the base layer is changed through the <a href="#control-layers">layer control</a>.</td>
</tr>
<tr id='map-overlayadd'>
<td><code><b>overlayadd</b>
<td><code><a href='#layerscontrolevent'>LayersControlEvent</a></code></td>
<td>Fired when an overlay is selected through the <a href="#control-layers">layer control</a>.</td>
</tr>
<tr id='map-overlayremove'>
<td><code><b>overlayremove</b>
<td><code><a href='#layerscontrolevent'>LayersControlEvent</a></code></td>
<td>Fired when an overlay is deselected through the <a href="#control-layers">layer control</a>.</td>
</tr>
<tr id='map-layeradd'>
<td><code><b>layeradd</b>
<td><code><a href='#layerevent'>LayerEvent</a></code></td>
<td>Fired when a new layer is added to the map.</td>
</tr>
<tr id='map-layerremove'>
<td><code><b>layerremove</b>
<td><code><a href='#layerevent'>LayerEvent</a></code></td>
<td>Fired when some layer is removed from the map</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-map-state-change-events'>Map state change events</h4>
<div class='section-comments'></div>
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-zoomlevelschange'>
<td><code><b>zoomlevelschange</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the number of zoomlevels on the map is changed due
to adding or removing a layer.</td>
</tr>
<tr id='map-resize'>
<td><code><b>resize</b>
<td><code><a href='#resizeevent'>ResizeEvent</a></code></td>
<td>Fired when the map is resized.</td>
</tr>
<tr id='map-unload'>
<td><code><b>unload</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the map is destroyed with <a href="#map-remove">remove</a> method.</td>
</tr>
<tr id='map-viewreset'>
<td><code><b>viewreset</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the map needs to redraw its content (this usually happens
on map zoom or load). Very useful for creating custom overlays.</td>
</tr>
<tr id='map-load'>
<td><code><b>load</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the map is initialized (when its center and zoom are set
for the first time).</td>
</tr>
<tr id='map-zoomstart'>
<td><code><b>zoomstart</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the map zoom is about to change (e.g. before zoom animation).</td>
</tr>
<tr id='map-movestart'>
<td><code><b>movestart</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the view of the map starts changing (e.g. user starts dragging the map).</td>
</tr>
<tr id='map-zoom'>
<td><code><b>zoom</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired repeatedly during any change in zoom level, including zoom
and fly animations.</td>
</tr>
<tr id='map-move'>
<td><code><b>move</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired repeatedly during any movement of the map, including pan and
fly animations.</td>
</tr>
<tr id='map-zoomend'>
<td><code><b>zoomend</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the map has changed, after any animations.</td>
</tr>
<tr id='map-moveend'>
<td><code><b>moveend</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the center of the map stops changing (e.g. user stopped
dragging the map).</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-popup-events'>Popup events</h4>
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup is opened in the map</td>
</tr>
<tr id='map-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup in the map is closed</td>
</tr>
<tr id='map-autopanstart'>
<td><code><b>autopanstart</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the map starts autopanning when opening a popup.</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-tooltip-events'>Tooltip events</h4>
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip is opened in the map.</td>
</tr>
<tr id='map-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip in the map is closed.</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-location-events'>Location events</h4>
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-locationerror'>
<td><code><b>locationerror</b>
<td><code><a href='#errorevent'>ErrorEvent</a></code></td>
<td>Fired when geolocation (using the <a href="#map-locate"><code>locate</code></a> method) failed.</td>
</tr>
<tr id='map-locationfound'>
<td><code><b>locationfound</b>
<td><code><a href='#locationevent'>LocationEvent</a></code></td>
<td>Fired when geolocation (using the <a href="#map-locate"><code>locate</code></a> method)
went successfully.</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-interaction-events'>Interaction events</h4>
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-click'>
<td><code><b>click</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the map.</td>
</tr>
<tr id='map-dblclick'>
<td><code><b>dblclick</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the map.</td>
</tr>
<tr id='map-mousedown'>
<td><code><b>mousedown</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the map.</td>
</tr>
<tr id='map-mouseup'>
<td><code><b>mouseup</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user releases the mouse button on the map.</td>
</tr>
<tr id='map-mouseover'>
<td><code><b>mouseover</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse enters the map.</td>
</tr>
<tr id='map-mouseout'>
<td><code><b>mouseout</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse leaves the map.</td>
</tr>
<tr id='map-mousemove'>
<td><code><b>mousemove</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired while the mouse moves over the map.</td>
</tr>
<tr id='map-contextmenu'>
<td><code><b>contextmenu</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user pushes the right mouse button on the map, prevents
default browser context menu from showing if there are listeners on
this event. Also fired on mobile when the user holds a single touch
for a second (also called long press).</td>
</tr>
<tr id='map-keypress'>
<td><code><b>keypress</b>
<td><code><a href='#keyboardevent'>KeyboardEvent</a></code></td>
<td>Fired when the user presses a key from the keyboard while the map is focused.</td>
</tr>
<tr id='map-preclick'>
<td><code><b>preclick</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired before mouse click on the map (sometimes useful when you
want something to happen on click before any existing click
handlers start running).</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-other-methods'>Other Methods</h4>
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-zoomanim'>
<td><code><b>zoomanim</b>
<td><code><a href='#zoomanimevent'>ZoomAnimEvent</a></code></td>
<td>Fired on every frame of a zoom animation</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='map-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-getrenderer'>
<td><code><b>getRenderer</b>(<nobr><<a href='#path'>Path</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code><a href='#renderer'>Renderer</a></code></td>
<td><p>Returns the instance of <a href="#renderer"><code>Renderer</code></a> that should be used to render the given
<a href="#path"><code>Path</code></a>. It will ensure that the <a href="#renderer"><code>renderer</code></a> options of the map and paths
are respected, and that the renderers do exist on the map.</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-methods-for-layers-and-controls'>Methods for Layers and Controls</h4>
<div class='section-comments'></div>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-addcontrol'>
<td><code><b>addControl</b>(<nobr><<a href='#control'>Control</a>></nobr> <i>control</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the given control to the map</p>
</td>
</tr>
<tr id='map-removecontrol'>
<td><code><b>removeControl</b>(<nobr><<a href='#control'>Control</a>></nobr> <i>control</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the given control from the map</p>
</td>
</tr>
<tr id='map-addlayer'>
<td><code><b>addLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the given layer to the map</p>
</td>
</tr>
<tr id='map-removelayer'>
<td><code><b>removeLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the given layer from the map.</p>
</td>
</tr>
<tr id='map-haslayer'>
<td><code><b>hasLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the given layer is currently added to the map</p>
</td>
</tr>
<tr id='map-eachlayer'>
<td><code><b>eachLayer</b>(<nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Iterates over the layers of the map, optionally specifying context of the iterator function.</p>
<pre><code>map.eachLayer(function(layer){
layer.bindPopup('Hello');
});
</code></pre></td>
</tr>
<tr id='map-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#popup'>Popup</a>></nobr> <i>popup</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability).</p>
</td>
</tr>
<tr id='map-openpopup'>
<td><code><b>openPopup</b>(<nobr><String|HTMLElement></nobr> <i>content</i>, <nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Creates a popup with the specified content and options and opens it in the given point on a map.</p>
</td>
</tr>
<tr id='map-closepopup'>
<td><code><b>closePopup</b>(<nobr><<a href='#popup'>Popup</a>></nobr> <i>popup?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup previously opened with <a href="#map-openpopup">openPopup</a> (or the given one).</p>
</td>
</tr>
<tr id='map-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#tooltip'>Tooltip</a>></nobr> <i>tooltip</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the specified tooltip.</p>
</td>
</tr>
<tr id='map-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><String|HTMLElement></nobr> <i>content</i>, <nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Creates a tooltip with the specified content and options and open it.</p>
</td>
</tr>
<tr id='map-closetooltip'>
<td><code><b>closeTooltip</b>(<nobr><<a href='#tooltip'>Tooltip</a>></nobr> <i>tooltip?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip given as parameter.</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-methods-for-modifying-map-state'>Methods for modifying map state</h4>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-setview'>
<td><code><b>setView</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>center</i>, <nobr><Number></nobr> <i>zoom</i>, <nobr><<a href='#zoom/pan-options'>Zoom/pan options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the view of the map (geographical center and zoom) with the given
animation options.</p>
</td>
</tr>
<tr id='map-setzoom'>
<td><code><b>setZoom</b>(<nobr><Number></nobr> <i>zoom</i>, <nobr><<a href='#zoom/pan-options'>Zoom/pan options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the zoom of the map.</p>
</td>
</tr>
<tr id='map-zoomin'>
<td><code><b>zoomIn</b>(<nobr><Number></nobr> <i>delta?</i>, <nobr><<a href='#zoom-options'>Zoom options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Increases the zoom of the map by <code>delta</code> (<a href="#map-zoomdelta"><code>zoomDelta</code></a> by default).</p>
</td>
</tr>
<tr id='map-zoomout'>
<td><code><b>zoomOut</b>(<nobr><Number></nobr> <i>delta?</i>, <nobr><<a href='#zoom-options'>Zoom options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Decreases the zoom of the map by <code>delta</code> (<a href="#map-zoomdelta"><code>zoomDelta</code></a> by default).</p>
</td>
</tr>
<tr id='map-setzoomaround'>
<td><code><b>setZoomAround</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><Number></nobr> <i>zoom</i>, <nobr><<a href='#zoom-options'>Zoom options</a>></nobr> <i>options</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Zooms the map while keeping a specified geographical point on the map
stationary (e.g. used internally for scroll zoom and double-click zoom).</p>
</td>
</tr>
<tr id='map-setzoomaround'>
<td><code><b>setZoomAround</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>offset</i>, <nobr><Number></nobr> <i>zoom</i>, <nobr><<a href='#zoom-options'>Zoom options</a>></nobr> <i>options</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Zooms the map while keeping a specified pixel on the map (relative to the top-left corner) stationary.</p>
</td>
</tr>
<tr id='map-fitbounds'>
<td><code><b>fitBounds</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>bounds</i>, <nobr><<a href='#fitbounds-options'>fitBounds options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets a map view that contains the given geographical bounds with the
maximum zoom level possible.</p>
</td>
</tr>
<tr id='map-fitworld'>
<td><code><b>fitWorld</b>(<nobr><<a href='#fitbounds-options'>fitBounds options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets a map view that mostly contains the whole world with the maximum
zoom level possible.</p>
</td>
</tr>
<tr id='map-panto'>
<td><code><b>panTo</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><<a href='#pan-options'>Pan options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Pans the map to a given center.</p>
</td>
</tr>
<tr id='map-panby'>
<td><code><b>panBy</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>offset</i>, <nobr><<a href='#pan-options'>Pan options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Pans the map by a given number of pixels (animated).</p>
</td>
</tr>
<tr id='map-flyto'>
<td><code><b>flyTo</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><Number></nobr> <i>zoom?</i>, <nobr><<a href='#zoom/pan-options'>Zoom/pan options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the view of the map (geographical center and zoom) performing a smooth
pan-zoom animation.</p>
</td>
</tr>
<tr id='map-flytobounds'>
<td><code><b>flyToBounds</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>bounds</i>, <nobr><<a href='#fitbounds-options'>fitBounds options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the view of the map with a smooth animation like <a href="#map-flyto"><code>flyTo</code></a>,
but takes a bounds parameter like <a href="#map-fitbounds"><code>fitBounds</code></a>.</p>
</td>
</tr>
<tr id='map-setmaxbounds'>
<td><code><b>setMaxBounds</b>(<nobr><<a href='#bounds'>Bounds</a>></nobr> <i>bounds</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Restricts the map view to the given bounds (see the <a href="#map-maxbounds">maxBounds</a> option).</p>
</td>
</tr>
<tr id='map-setminzoom'>
<td><code><b>setMinZoom</b>(<nobr><Number></nobr> <i>zoom</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the lower limit for the available zoom levels (see the <a href="#map-minzoom">minZoom</a> option).</p>
</td>
</tr>
<tr id='map-setmaxzoom'>
<td><code><b>setMaxZoom</b>(<nobr><Number></nobr> <i>zoom</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the upper limit for the available zoom levels (see the <a href="#map-maxzoom">maxZoom</a> option).</p>
</td>
</tr>
<tr id='map-paninsidebounds'>
<td><code><b>panInsideBounds</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>bounds</i>, <nobr><<a href='#pan-options'>Pan options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Pans the map to the closest view that would lie inside the given bounds (if it's not already), controlling the animation using the options specific, if any.</p>
</td>
</tr>
<tr id='map-invalidatesize'>
<td><code><b>invalidateSize</b>(<nobr><Zoom/Pan options></nobr> <i>options</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Checks if the map container size changed and updates the map if so —
call it after you've changed the map size dynamically, also animating
pan by default. If <code>options.pan</code> is <code>false</code>, panning will not occur.
If <code>options.debounceMoveend</code> is <code>true</code>, it will delay <code>moveend</code> event so
that it doesn't happen often even if the method is called many
times in a row.</p>
</td>
</tr>
<tr id='map-invalidatesize'>
<td><code><b>invalidateSize</b>(<nobr><Boolean></nobr> <i>animate</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Checks if the map container size changed and updates the map if so —
call it after you've changed the map size dynamically, also animating
pan by default.</p>
</td>
</tr>
<tr id='map-stop'>
<td><code><b>stop</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Stops the currently running <code>panTo</code> or <code>flyTo</code> animation, if any.</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-geolocation-methods'>Geolocation methods</h4>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-locate'>
<td><code><b>locate</b>(<nobr><<a href='#locate-options'>Locate options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Tries to locate the user using the Geolocation API, firing a <a href="#map-locationfound"><code>locationfound</code></a>
event with location data on success or a <a href="#map-locationerror"><code>locationerror</code></a> event on failure,
and optionally sets the map view to the user's location with respect to
detection accuracy (or to the world view if geolocation failed).
Note that, if your page doesn't use HTTPS, this method will fail in
modern browsers (<a href="https://sites.google.com/a/chromium.org/dev/Home/chromium-security/deprecating-powerful-features-on-insecure-origins">Chrome 50 and newer</a>)
See <a href="#locate-options"><code>Locate options</code></a> for more details.</p>
</td>
</tr>
<tr id='map-stoplocate'>
<td><code><b>stopLocate</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Stops watching location previously initiated by <code>map.locate({watch: true})</code>
and aborts resetting the map view if map.locate was called with
<code>{setView: true}</code>.</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-other-methods'>Other Methods</h4>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-addhandler'>
<td><code><b>addHandler</b>(<nobr><String></nobr> <i>name</i>, <nobr><Function></nobr> <i>HandlerClass</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a new <a href="#handler"><code>Handler</code></a> to the map, given its name and constructor function.</p>
</td>
</tr>
<tr id='map-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Destroys the map and clears all related event listeners.</p>
</td>
</tr>
<tr id='map-createpane'>
<td><code><b>createPane</b>(<nobr><String></nobr> <i>name</i>, <nobr><HTMLElement></nobr> <i>container?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Creates a new <a href="#map-pane">map pane</a> with the given name if it doesn't exist already,
then returns it. The pane is created as a child of <code>container</code>, or
as a child of the main map pane if not set.</p>
</td>
</tr>
<tr id='map-getpane'>
<td><code><b>getPane</b>(<nobr><String|HTMLElement></nobr> <i>pane</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns a <a href="#map-pane">map pane</a>, given its name or its HTML element (its identity).</p>
</td>
</tr>
<tr id='map-getpanes'>
<td><code><b>getPanes</b>()</nobr></code></td>
<td><code>Object</code></td>
<td><p>Returns a plain object containing the names of all <a href="#map-pane">panes</a> as keys and
the panes as values.</p>
</td>
</tr>
<tr id='map-getcontainer'>
<td><code><b>getContainer</b>()</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the HTML element that contains the map.</p>
</td>
</tr>
<tr id='map-whenready'>
<td><code><b>whenReady</b>(<nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Runs the given function <code>fn</code> when the map gets initialized with
a view (center and zoom) and at least one layer, or immediately
if it's already initialized, optionally passing a function context.</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-methods-for-getting-map-state'>Methods for Getting Map State</h4>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-getcenter'>
<td><code><b>getCenter</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the geographical center of the map view</p>
</td>
</tr>
<tr id='map-getzoom'>
<td><code><b>getZoom</b>()</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the current zoom level of the map view</p>
</td>
</tr>
<tr id='map-getbounds'>
<td><code><b>getBounds</b>()</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Returns the geographical bounds visible in the current map view</p>
</td>
</tr>
<tr id='map-getminzoom'>
<td><code><b>getMinZoom</b>()</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the minimum zoom level of the map (if set in the <code>minZoom</code> option of the map or of any layers), or <code>0</code> by default.</p>
</td>
</tr>
<tr id='map-getmaxzoom'>
<td><code><b>getMaxZoom</b>()</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the maximum zoom level of the map (if set in the <code>maxZoom</code> option of the map or of any layers).</p>
</td>
</tr>
<tr id='map-getboundszoom'>
<td><code><b>getBoundsZoom</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>bounds</i>, <nobr><Boolean></nobr> <i>inside?</i>)</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the maximum zoom level on which the given bounds fit to the map
view in its entirety. If <code>inside</code> (optional) is set to <code>true</code>, the method
instead returns the minimum zoom level on which the map view fits into
the given bounds in its entirety.</p>
</td>
</tr>
<tr id='map-getsize'>
<td><code><b>getSize</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the current size of the map container (in pixels).</p>
</td>
</tr>
<tr id='map-getpixelbounds'>
<td><code><b>getPixelBounds</b>()</nobr></code></td>
<td><code><a href='#bounds'>Bounds</a></code></td>
<td><p>Returns the bounds of the current map view in projected pixel
coordinates (sometimes useful in layer and overlay implementations).</p>
</td>
</tr>
<tr id='map-getpixelorigin'>
<td><code><b>getPixelOrigin</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the projected pixel coordinates of the top left point of
the map layer (useful in custom layer and overlay implementations).</p>
</td>
</tr>
<tr id='map-getpixelworldbounds'>
<td><code><b>getPixelWorldBounds</b>(<nobr><Number></nobr> <i>zoom?</i>)</nobr></code></td>
<td><code><a href='#bounds'>Bounds</a></code></td>
<td><p>Returns the world's bounds in pixel coordinates for zoom level <code>zoom</code>.
If <code>zoom</code> is omitted, the map's current zoom level is used.</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-conversion-methods'>Conversion Methods</h4>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-getzoomscale'>
<td><code><b>getZoomScale</b>(<nobr><Number></nobr> <i>toZoom</i>, <nobr><Number></nobr> <i>fromZoom</i>)</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the scale factor to be applied to a map transition from zoom level
<code>fromZoom</code> to <code>toZoom</code>. Used internally to help with zoom animations.</p>
</td>
</tr>
<tr id='map-getscalezoom'>
<td><code><b>getScaleZoom</b>(<nobr><Number></nobr> <i>scale</i>, <nobr><Number></nobr> <i>fromZoom</i>)</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the zoom level that the map would end up at, if it is at <code>fromZoom</code>
level and everything is scaled by a factor of <code>scale</code>. Inverse of
<a href="#map-getZoomScale"><code>getZoomScale</code></a>.</p>
</td>
</tr>
<tr id='map-project'>
<td><code><b>project</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><Number></nobr> <i>zoom</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Projects a geographical coordinate <a href="#latlng"><code>LatLng</code></a> according to the projection
of the map's CRS, then scales it according to <code>zoom</code> and the CRS's
<a href="#transformation"><code>Transformation</code></a>. The result is pixel coordinate relative to
the CRS origin.</p>
</td>
</tr>
<tr id='map-unproject'>
<td><code><b>unproject</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>point</i>, <nobr><Number></nobr> <i>zoom</i>)</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Inverse of <a href="#map-project"><code>project</code></a>.</p>
</td>
</tr>
<tr id='map-layerpointtolatlng'>
<td><code><b>layerPointToLatLng</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>point</i>)</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Given a pixel coordinate relative to the <a href="#map-getpixelorigin">origin pixel</a>,
returns the corresponding geographical coordinate (for the current zoom level).</p>
</td>
</tr>
<tr id='map-latlngtolayerpoint'>
<td><code><b>latLngToLayerPoint</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Given a geographical coordinate, returns the corresponding pixel coordinate
relative to the <a href="#map-getpixelorigin">origin pixel</a>.</p>
</td>
</tr>
<tr id='map-wraplatlng'>
<td><code><b>wrapLatLng</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns a <a href="#latlng"><code>LatLng</code></a> where <code>lat</code> and <code>lng</code> has been wrapped according to the
map's CRS's <code>wrapLat</code> and <code>wrapLng</code> properties, if they are outside the
CRS's bounds.
By default this means longitude is wrapped around the dateline so its
value is between -180 and +180 degrees.</p>
</td>
</tr>
<tr id='map-wraplatlngbounds'>
<td><code><b>wrapLatLngBounds</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>bounds</i>)</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Returns a <a href="#latlngbounds"><code>LatLngBounds</code></a> with the same size as the given one, ensuring that
its center is within the CRS's bounds.
By default this means the center longitude is wrapped around the dateline so its
value is between -180 and +180 degrees, and the majority of the bounds
overlaps the CRS's bounds.</p>
</td>
</tr>
<tr id='map-distance'>
<td><code><b>distance</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng1</i>, <nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng2</i>)</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the distance between two geographical coordinates according to
the map's CRS. By default this measures distance in meters.</p>
</td>
</tr>
<tr id='map-containerpointtolayerpoint'>
<td><code><b>containerPointToLayerPoint</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>point</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Given a pixel coordinate relative to the map container, returns the corresponding
pixel coordinate relative to the <a href="#map-getpixelorigin">origin pixel</a>.</p>
</td>
</tr>
<tr id='map-layerpointtocontainerpoint'>
<td><code><b>layerPointToContainerPoint</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>point</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Given a pixel coordinate relative to the <a href="#map-getpixelorigin">origin pixel</a>,
returns the corresponding pixel coordinate relative to the map container.</p>
</td>
</tr>
<tr id='map-containerpointtolatlng'>
<td><code><b>containerPointToLatLng</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>point</i>)</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Given a pixel coordinate relative to the map container, returns
the corresponding geographical coordinate (for the current zoom level).</p>
</td>
</tr>
<tr id='map-latlngtocontainerpoint'>
<td><code><b>latLngToContainerPoint</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Given a geographical coordinate, returns the corresponding pixel coordinate
relative to the map container.</p>
</td>
</tr>
<tr id='map-mouseeventtocontainerpoint'>
<td><code><b>mouseEventToContainerPoint</b>(<nobr><<a href='#mouseevent'>MouseEvent</a>></nobr> <i>ev</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Given a MouseEvent object, returns the pixel coordinate relative to the
map container where the event took place.</p>
</td>
</tr>
<tr id='map-mouseeventtolayerpoint'>
<td><code><b>mouseEventToLayerPoint</b>(<nobr><<a href='#mouseevent'>MouseEvent</a>></nobr> <i>ev</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Given a MouseEvent object, returns the pixel coordinate relative to
the <a href="#map-getpixelorigin">origin pixel</a> where the event took place.</p>
</td>
</tr>
<tr id='map-mouseeventtolatlng'>
<td><code><b>mouseEventToLatLng</b>(<nobr><<a href='#mouseevent'>MouseEvent</a>></nobr> <i>ev</i>)</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Given a MouseEvent object, returns geographical coordinate where the
event took place.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='map-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='map-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='map-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='map-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='map-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='map-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='map-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='map-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='map-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='map-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='map-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='map-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='map-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='map-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='map-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='map-property'>Properties</h3>
<section class='collapsable'>
<h4 id='map-handlers'>Handlers</h4>
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-boxzoom'>
<td><code><b>boxZoom</b>
<td><code><a href='#handler'>Handler</a></code></td>
<td>Box (shift-drag with mouse) zoom handler.</td>
</tr>
<tr id='map-doubleclickzoom'>
<td><code><b>doubleClickZoom</b>
<td><code><a href='#handler'>Handler</a></code></td>
<td>Double click zoom handler.</td>
</tr>
<tr id='map-dragging'>
<td><code><b>dragging</b>
<td><code><a href='#handler'>Handler</a></code></td>
<td>Map dragging handler (by both mouse and touch).</td>
</tr>
<tr id='map-keyboard'>
<td><code><b>keyboard</b>
<td><code><a href='#handler'>Handler</a></code></td>
<td>Keyboard navigation handler.</td>
</tr>
<tr id='map-scrollwheelzoom'>
<td><code><b>scrollWheelZoom</b>
<td><code><a href='#handler'>Handler</a></code></td>
<td>Scroll wheel zoom handler.</td>
</tr>
<tr id='map-tap'>
<td><code><b>tap</b>
<td><code><a href='#handler'>Handler</a></code></td>
<td>Mobile touch hacks (quick tap and touch hold) handler.</td>
</tr>
<tr id='map-touchzoom'>
<td><code><b>touchZoom</b>
<td><code><a href='#handler'>Handler</a></code></td>
<td>Touch zoom handler.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='map-pane'>Map panes</h3>
<section >
<div class='section-comments'>Panes are DOM elements used to control the ordering of layers on the map. You
can access panes with <a href="#map-getpane"><code>map.getPane</code></a> or
<a href="#map-getpanes"><code>map.getPanes</code></a> methods. New panes can be created with the
<a href="#map-createpane"><code>map.createPane</code></a> method.
Every map has the following default panes that differ only in zIndex.</div>
<table><thead>
<tr>
<th>Pane</th>
<th>Type</th>
<th>Z-index</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='map-mappane'>
<td><code><b>mapPane</b></code></td>
<td><code>HTMLElement</code>
<td><code>'auto'</code></td>
<td>Pane that contains all other map panes</td>
</tr>
<tr id='map-tilepane'>
<td><code><b>tilePane</b></code></td>
<td><code>HTMLElement</code>
<td><code>200</code></td>
<td>Pane for <a href="#gridlayer"><code>GridLayer</code></a>s and <a href="#tilelayer"><code>TileLayer</code></a>s</td>
</tr>
<tr id='map-overlaypane'>
<td><code><b>overlayPane</b></code></td>
<td><code>HTMLElement</code>
<td><code>400</code></td>
<td>Pane for vector overlays (<a href="#path"><code>Path</code></a>s), like <a href="#polyline"><code>Polyline</code></a>s and <a href="#polygon"><code>Polygon</code></a>s</td>
</tr>
<tr id='map-shadowpane'>
<td><code><b>shadowPane</b></code></td>
<td><code>HTMLElement</code>
<td><code>500</code></td>
<td>Pane for overlay shadows (e.g. <a href="#marker"><code>Marker</code></a> shadows)</td>
</tr>
<tr id='map-markerpane'>
<td><code><b>markerPane</b></code></td>
<td><code>HTMLElement</code>
<td><code>600</code></td>
<td>Pane for <a href="#icon"><code>Icon</code></a>s of <a href="#marker"><code>Marker</code></a>s</td>
</tr>
<tr id='map-tooltippane'>
<td><code><b>tooltipPane</b></code></td>
<td><code>HTMLElement</code>
<td><code>650</code></td>
<td>Pane for tooltip.</td>
</tr>
<tr id='map-popuppane'>
<td><code><b>popupPane</b></code></td>
<td><code>HTMLElement</code>
<td><code>700</code></td>
<td>Pane for <a href="#popup"><code>Popup</code></a>s.</td>
</tr>
</tbody></table>
</section>
</section><span id='locate-options'></span>
<section>
<h3 id='locate-options-option'>Locate options</h3>
<section >
<div class='section-comments'>Some of the geolocation methods for <a href="#map"><code>Map</code></a> take in an <code>options</code> parameter. This
is a plain javascript object with the following optional components:</div>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='locate-options-watch'>
<td><code><b>watch</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, starts continous watching of location changes (instead of detecting it
once) using W3C <code>watchPosition</code> method. You can later stop watching using
<code>map.stopLocate()</code> method.</td>
</tr>
<tr id='locate-options-setview'>
<td><code><b>setView</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, automatically sets the map view to the user location with respect to
detection accuracy, or to world view if geolocation failed.</td>
</tr>
<tr id='locate-options-maxzoom'>
<td><code><b>maxZoom</b></code></td>
<td><code>Number</code>
<td><code>Infinity</code></td>
<td>The maximum zoom for automatic view setting when using <code>setView</code> option.</td>
</tr>
<tr id='locate-options-timeout'>
<td><code><b>timeout</b></code></td>
<td><code>Number</code>
<td><code>10000</code></td>
<td>Number of milliseconds to wait for a response from geolocation before firing a
<code>locationerror</code> event.</td>
</tr>
<tr id='locate-options-maximumage'>
<td><code><b>maximumAge</b></code></td>
<td><code>Number</code>
<td><code>0</code></td>
<td>Maximum age of detected location. If less than this amount of milliseconds
passed since last geolocation response, <code>locate</code> will return a cached location.</td>
</tr>
<tr id='locate-options-enablehighaccuracy'>
<td><code><b>enableHighAccuracy</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>Enables high accuracy, see <a href="http://dev.w3.org/geo/api/spec-source.html#high-accuracy">description in the W3C spec</a>.</td>
</tr>
</tbody></table>
</section>
</section><span id='zoom-options'></span>
<section>
<h3 id='zoom-options-option'>Zoom options</h3>
<section >
<div class='section-comments'>Some of the <a href="#map"><code>Map</code></a> methods which modify the zoom level take in an <code>options</code>
parameter. This is a plain javascript object with the following optional
components:</div>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='zoom-options-animate'>
<td><code><b>animate</b></code></td>
<td><code>Boolean</code>
<td><code></code></td>
<td>If not specified, zoom animation will happen if the zoom origin is inside the
current view. If <code>true</code>, the map will attempt animating zoom disregarding where
zoom origin is. Setting <code>false</code> will make it always reset the view completely
without animation.</td>
</tr>
</tbody></table>
</section>
</section><span id='pan-options'></span>
<section>
<h3 id='pan-options-option'>Pan options</h3>
<section >
<div class='section-comments'>Some of the <a href="#map"><code>Map</code></a> methods which modify the center of the map take in an <code>options</code>
parameter. This is a plain javascript object with the following optional
components:</div>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='pan-options-animate'>
<td><code><b>animate</b></code></td>
<td><code>Boolean</code>
<td><code></code></td>
<td>If <code>true</code>, panning will always be animated if possible. If <code>false</code>, it will
not animate panning, either resetting the map view if panning more than a
screen away, or just setting a new offset for the map pane (except for <code>panBy</code>
which always does the latter).</td>
</tr>
<tr id='pan-options-duration'>
<td><code><b>duration</b></code></td>
<td><code>Number</code>
<td><code>0.25</code></td>
<td>Duration of animated panning, in seconds.</td>
</tr>
<tr id='pan-options-easelinearity'>
<td><code><b>easeLinearity</b></code></td>
<td><code>Number</code>
<td><code>0.25</code></td>
<td>The curvature factor of panning animation easing (third parameter of the
<a href="http://cubic-bezier.com/">Cubic Bezier curve</a>). 1.0 means linear animation,
and the smaller this number, the more bowed the curve.</td>
</tr>
<tr id='pan-options-nomovestart'>
<td><code><b>noMoveStart</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, panning won't fire <code>movestart</code> event on start (used internally for
panning inertia).</td>
</tr>
</tbody></table>
</section>
</section><span id='zoom/pan-options'></span>
<section>
<h3 id=''>Zoom/pan options</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#zoom-options'>Zoom options</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='zoom/pan-options-animate'>
<td><code><b>animate</b></code></td>
<td><code>Boolean</code>
<td><code></code></td>
<td>If not specified, zoom animation will happen if the zoom origin is inside the
current view. If <code>true</code>, the map will attempt animating zoom disregarding where
zoom origin is. Setting <code>false</code> will make it always reset the view completely
without animation.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#pan-options'>Pan options</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='zoom/pan-options-duration'>
<td><code><b>duration</b></code></td>
<td><code>Number</code>
<td><code>0.25</code></td>
<td>Duration of animated panning, in seconds.</td>
</tr>
<tr id='zoom/pan-options-easelinearity'>
<td><code><b>easeLinearity</b></code></td>
<td><code>Number</code>
<td><code>0.25</code></td>
<td>The curvature factor of panning animation easing (third parameter of the
<a href="http://cubic-bezier.com/">Cubic Bezier curve</a>). 1.0 means linear animation,
and the smaller this number, the more bowed the curve.</td>
</tr>
<tr id='zoom/pan-options-nomovestart'>
<td><code><b>noMoveStart</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, panning won't fire <code>movestart</code> event on start (used internally for
panning inertia).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='fitbounds-options'></span>
<section>
<h3 id='fitbounds-options-option'>FitBounds options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='fitbounds-options-paddingtopleft'>
<td><code><b>paddingTopLeft</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>[0, 0]</code></td>
<td>Sets the amount of padding in the top left corner of a map container that
shouldn't be accounted for when setting the view to fit bounds. Useful if you
have some control overlays on the map like a sidebar and you don't want them
to obscure objects you're zooming to.</td>
</tr>
<tr id='fitbounds-options-paddingbottomright'>
<td><code><b>paddingBottomRight</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>[0, 0]</code></td>
<td>The same for the bottom right corner of the map.</td>
</tr>
<tr id='fitbounds-options-padding'>
<td><code><b>padding</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>[0, 0]</code></td>
<td>Equivalent of setting both top left and bottom right padding to the same value.</td>
</tr>
<tr id='fitbounds-options-maxzoom'>
<td><code><b>maxZoom</b></code></td>
<td><code>Number</code>
<td><code>null</code></td>
<td>The maximum possible zoom to use.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#zoom-options'>Zoom options</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='fitbounds-options-animate'>
<td><code><b>animate</b></code></td>
<td><code>Boolean</code>
<td><code></code></td>
<td>If not specified, zoom animation will happen if the zoom origin is inside the
current view. If <code>true</code>, the map will attempt animating zoom disregarding where
zoom origin is. Setting <code>false</code> will make it always reset the view completely
without animation.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#pan-options'>Pan options</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='fitbounds-options-duration'>
<td><code><b>duration</b></code></td>
<td><code>Number</code>
<td><code>0.25</code></td>
<td>Duration of animated panning, in seconds.</td>
</tr>
<tr id='fitbounds-options-easelinearity'>
<td><code><b>easeLinearity</b></code></td>
<td><code>Number</code>
<td><code>0.25</code></td>
<td>The curvature factor of panning animation easing (third parameter of the
<a href="http://cubic-bezier.com/">Cubic Bezier curve</a>). 1.0 means linear animation,
and the smaller this number, the more bowed the curve.</td>
</tr>
<tr id='fitbounds-options-nomovestart'>
<td><code><b>noMoveStart</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, panning won't fire <code>movestart</code> event on start (used internally for
panning inertia).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='marker'>Marker</h2><p>L.Marker is used to display clickable/draggable icons on the map. Extends <a href="#layer"><code>Layer</code></a>.</p>
<section>
<h3 id='marker-example'>Usage example</h3>
<section >
<pre><code class="lang-js">L.marker([50.5, 30.5]).addTo(map);
</code></pre>
</section>
</section><section>
<h3 id='marker-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-l-marker'>
<td><code><b>L.marker</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><<a href='#marker-option'>Marker options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Instantiates a Marker object given a geographical point and optionally an options object.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='marker-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-icon'>
<td><code><b>icon</b></code></td>
<td><code><a href='#icon'>Icon</a></code>
<td><code>*</code></td>
<td>Icon instance to use for rendering the marker.
See <a href="#icon">Icon documentation</a> for details on how to customize the marker icon.
If not specified, a common instance of <a href="#icon-default"><code>L.Icon.Default</code></a> is used.</td>
</tr>
<tr id='marker-draggable'>
<td><code><b>draggable</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>Whether the marker is draggable with mouse/touch or not.</td>
</tr>
<tr id='marker-keyboard'>
<td><code><b>keyboard</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether the marker can be tabbed to with a keyboard and clicked by pressing enter.</td>
</tr>
<tr id='marker-title'>
<td><code><b>title</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>Text for the browser tooltip that appear on marker hover (no tooltip by default).</td>
</tr>
<tr id='marker-alt'>
<td><code><b>alt</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>Text for the <code>alt</code> attribute of the icon image (useful for accessibility).</td>
</tr>
<tr id='marker-zindexoffset'>
<td><code><b>zIndexOffset</b></code></td>
<td><code>Number</code>
<td><code>0</code></td>
<td>By default, marker images zIndex is set automatically based on its latitude. Use this option if you want to put the marker on top of all others (or below), specifying a high value like <code>1000</code> (or high negative value, respectively).</td>
</tr>
<tr id='marker-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>The opacity of the marker.</td>
</tr>
<tr id='marker-riseonhover'>
<td><code><b>riseOnHover</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, the marker will get on top of others when you hover the mouse over it.</td>
</tr>
<tr id='marker-riseoffset'>
<td><code><b>riseOffset</b></code></td>
<td><code>Number</code>
<td><code>250</code></td>
<td>The z-index offset used for the <code>riseOnHover</code> feature.</td>
</tr>
<tr id='marker-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'markerPane'</code></td>
<td><code>Map pane</code> where the markers icon will be added.</td>
</tr>
<tr id='marker-bubblingmouseevents'>
<td><code><b>bubblingMouseEvents</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>When <code>true</code>, a mouse event on this marker will trigger the same event on the map
(unless <a href="#domevent-stoppropagation"><code>L.DomEvent.stopPropagation</code></a> is used).</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-interactive'>
<td><code><b>interactive</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>If <code>false</code>, the layer will not emit mouse events and will act as a part of the underlying map.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='marker-event'>Events</h3>
<section >
<div class='section-comments'>In addition to <a href="#layer">shared layer methods</a> like <code>addTo()</code> and <code>remove()</code> and <a href="#popup">popup methods</a> like bindPopup() you can also use the following methods:</div>
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-move'>
<td><code><b>move</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the marker is moved via <a href="#marker-setlatlng"><code>setLatLng</code></a> or by <a href="#marker-dragging">dragging</a>. Old and new coordinates are included in event arguments as <code>oldLatLng</code>, <a href="#latlng"><code>latlng</code></a>.</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='marker-dragging-events'>Dragging events</h4>
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-dragstart'>
<td><code><b>dragstart</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the user starts dragging the marker.</td>
</tr>
<tr id='marker-movestart'>
<td><code><b>movestart</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the marker starts moving (because of dragging).</td>
</tr>
<tr id='marker-drag'>
<td><code><b>drag</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired repeatedly while the user drags the marker.</td>
</tr>
<tr id='marker-dragend'>
<td><code><b>dragend</b>
<td><code><a href='#dragendevent'>DragEndEvent</a></code></td>
<td>Fired when the user stops dragging the marker.</td>
</tr>
<tr id='marker-moveend'>
<td><code><b>moveend</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the marker stops moving (because of dragging).</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Mouse events inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-click'>
<td><code><b>click</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the layer.</td>
</tr>
<tr id='marker-dblclick'>
<td><code><b>dblclick</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the layer.</td>
</tr>
<tr id='marker-mousedown'>
<td><code><b>mousedown</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the layer.</td>
</tr>
<tr id='marker-mouseover'>
<td><code><b>mouseover</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse enters the layer.</td>
</tr>
<tr id='marker-mouseout'>
<td><code><b>mouseout</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse leaves the layer.</td>
</tr>
<tr id='marker-contextmenu'>
<td><code><b>contextmenu</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user right-clicks on the layer, prevents
default browser context menu from showing if there are listeners on
this event. Also fired on mobile when the user holds a single touch
for a second (also called long press).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='marker-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='marker-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='marker-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='marker-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-togeojson'>
<td><code><b>toGeoJSON</b>()</nobr></code></td>
<td><code>Object</code></td>
<td><p>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON"><a href="#geojson"><code>GeoJSON</code></a></a> representation of the marker (as a GeoJSON <a href="#point"><code>Point</code></a> Feature).</p>
</td>
</tr>
<tr id='marker-getlatlng'>
<td><code><b>getLatLng</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the current geographical position of the marker.</p>
</td>
</tr>
<tr id='marker-setlatlng'>
<td><code><b>setLatLng</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the marker position to the given point.</p>
</td>
</tr>
<tr id='marker-setzindexoffset'>
<td><code><b>setZIndexOffset</b>(<nobr><Number></nobr> <i>offset</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the <a href="#marker-zindexoffset">zIndex offset</a> of the marker.</p>
</td>
</tr>
<tr id='marker-seticon'>
<td><code><b>setIcon</b>(<nobr><<a href='#icon'>Icon</a>></nobr> <i>icon</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the marker icon.</p>
</td>
</tr>
<tr id='marker-setopacity'>
<td><code><b>setOpacity</b>(<nobr><Number></nobr> <i>opacity</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the opacity of the marker.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='marker-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='marker-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='marker-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='marker-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='marker-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='marker-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='marker-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='marker-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='marker-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='marker-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='marker-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='marker-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='marker-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='marker-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='marker-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='marker-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='marker-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='marker-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='marker-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='marker-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='marker-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='marker-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='marker-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='marker-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='marker-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='marker-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='marker-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='marker-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='marker-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='marker-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='marker-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='marker-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='marker-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='marker-property'>Properties</h3>
<section class='collapsable'>
<h4 id='marker-interaction-handlers'>Interaction handlers</h4>
<div class='section-comments'>Interaction handlers are properties of a marker instance that allow you to control interaction behavior in runtime, enabling or disabling certain features such as dragging (see <a href="#handler"><code>Handler</code></a> methods). Example:
<pre><code class="lang-js">marker.dragging.disable();
</code></pre></div>
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='marker-dragging'>
<td><code><b>dragging</b>
<td><code><a href='#handler'>Handler</a></code></td>
<td>Marker dragging handler (by both mouse and touch). Only valid when the marker is on the map (Otherwise set <a href="#marker-draggable"><code>marker.options.draggable</code></a>).</td>
</tr>
</tbody></table>
</section>
</section><h2 id='popup'>Popup</h2><p>Used to open popups in certain places of the map. Use <a href="#map-openpopup">Map.openPopup</a> to
open popups while making sure that only one popup is open at one time
(recommended for usability), or use <a href="#map-addlayer">Map.addLayer</a> to open as many as you want.</p>
<section>
<h3 id='popup-example'>Usage example</h3>
<section >
<p>If you want to just bind a popup to marker click and then open it, it's really easy:</p>
<pre><code class="lang-js">marker.bindPopup(popupContent).openPopup();
</code></pre>
<p>Path overlays like polylines also have a <code>bindPopup</code> method.
Here's a more complicated way to open a popup on a map:</p>
<pre><code class="lang-js">var popup = L.popup()
.setLatLng(latlng)
.setContent('<p>Hello world!<br />This is a nice popup.</p>')
.openOn(map);
</code></pre>
</section>
</section><section>
<h3 id='popup-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popup-l-popup'>
<td><code><b>L.popup</b>(<nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>, <nobr><<a href='#layer'>Layer</a>></nobr> <i>source?</i>)</nobr></code></td>
<td>Instantiates a <a href="#popup"><code>Popup</code></a> object given an optional <code>options</code> object that describes its appearance and location and an optional <code>source</code> object that is used to tag the popup with a reference to the Layer to which it refers.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='popup-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popup-maxwidth'>
<td><code><b>maxWidth</b></code></td>
<td><code>Number</code>
<td><code>300</code></td>
<td>Max width of the popup, in pixels.</td>
</tr>
<tr id='popup-minwidth'>
<td><code><b>minWidth</b></code></td>
<td><code>Number</code>
<td><code>50</code></td>
<td>Min width of the popup, in pixels.</td>
</tr>
<tr id='popup-maxheight'>
<td><code><b>maxHeight</b></code></td>
<td><code>Number</code>
<td><code>null</code></td>
<td>If set, creates a scrollable container of the given height
inside a popup if its content exceeds it.</td>
</tr>
<tr id='popup-autopan'>
<td><code><b>autoPan</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Set it to <code>false</code> if you don't want the map to do panning animation
to fit the opened popup.</td>
</tr>
<tr id='popup-autopanpaddingtopleft'>
<td><code><b>autoPanPaddingTopLeft</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>null</code></td>
<td>The margin between the popup and the top left corner of the map
view after autopanning was performed.</td>
</tr>
<tr id='popup-autopanpaddingbottomright'>
<td><code><b>autoPanPaddingBottomRight</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>null</code></td>
<td>The margin between the popup and the bottom right corner of the map
view after autopanning was performed.</td>
</tr>
<tr id='popup-autopanpadding'>
<td><code><b>autoPanPadding</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>Point(5, 5)</code></td>
<td>Equivalent of setting both top left and bottom right autopan padding to the same value.</td>
</tr>
<tr id='popup-keepinview'>
<td><code><b>keepInView</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>Set it to <code>true</code> if you want to prevent users from panning the popup
off of the screen while it is open.</td>
</tr>
<tr id='popup-closebutton'>
<td><code><b>closeButton</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Controls the presence of a close button in the popup.</td>
</tr>
<tr id='popup-autoclose'>
<td><code><b>autoClose</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Set it to <code>false</code> if you want to override the default behavior of
the popup closing when another popup is opened.</td>
</tr>
<tr id='popup-closeonclick'>
<td><code><b>closeOnClick</b></code></td>
<td><code>Boolean</code>
<td><code>*</code></td>
<td>Set it if you want to override the default behavior of the popup closing when user clicks
on the map. Defaults to the map's <a href="#map-closepopuponclick"><code>closePopupOnClick</code></a> option.</td>
</tr>
<tr id='popup-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>A custom CSS class name to assign to the popup.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#divoverlay'>DivOverlay</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popup-offset'>
<td><code><b>offset</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>Point(0, 7)</code></td>
<td>The offset of the popup position. Useful to control the anchor
of the popup when opening it on some overlays.</td>
</tr>
<tr id='popup-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'popupPane'</code></td>
<td><code>Map pane</code> where the popup will be added.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popup-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popup-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='popup-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popup-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='popup-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popup-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='popup-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='popup-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popup-getlatlng'>
<td><code><b>getLatLng</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the geographical point of popup.</p>
</td>
</tr>
<tr id='popup-setlatlng'>
<td><code><b>setLatLng</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the geographical point where the popup will open.</p>
</td>
</tr>
<tr id='popup-getcontent'>
<td><code><b>getContent</b>()</nobr></code></td>
<td><code>String|HTMLElement</code></td>
<td><p>Returns the content of the popup.</p>
</td>
</tr>
<tr id='popup-setcontent'>
<td><code><b>setContent</b>(<nobr><String|HTMLElement|Function></nobr> <i>htmlContent</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the HTML content of the popup. If a function is passed the source layer will be passed to the function. The function should return a <code>String</code> or <code>HTMLElement</code> to be used in the popup.</p>
</td>
</tr>
<tr id='popup-getelement'>
<td><code><b>getElement</b>()</nobr></code></td>
<td><code>String|HTMLElement</code></td>
<td><p>Alias for <a href="#popup-getcontent">getContent()</a></p>
</td>
</tr>
<tr id='popup-update'>
<td><code><b>update</b>()</nobr></code></td>
<td><code>null</code></td>
<td><p>Updates the popup content, layout and position. Useful for updating the popup after something inside changed, e.g. image loaded.</p>
</td>
</tr>
<tr id='popup-isopen'>
<td><code><b>isOpen</b>()</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> when the popup is visible on the map.</p>
</td>
</tr>
<tr id='popup-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings this popup in front of other popups (in the same map pane).</p>
</td>
</tr>
<tr id='popup-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings this popup to the back of other popups (in the same map pane).</p>
</td>
</tr>
<tr id='popup-openon'>
<td><code><b>openOn</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the popup to the map and closes the previous one. The same as <code>map.openPopup(popup)</code>.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popup-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='popup-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='popup-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='popup-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='popup-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popup-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='popup-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='popup-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='popup-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='popup-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='popup-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='popup-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='popup-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popup-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='popup-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='popup-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='popup-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='popup-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='popup-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='popup-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='popup-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popup-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='popup-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='popup-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='popup-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='popup-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='popup-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='popup-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='popup-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='popup-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='popup-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='popup-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='popup-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='popup-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='popup-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='popup-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='popup-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='tooltip'>Tooltip</h2><p>Used to display small texts on top of map layers.</p>
<section>
<h3 id='tooltip-example'>Usage example</h3>
<section >
<pre><code class="lang-js">marker.bindTooltip("my tooltip text").openTooltip();
</code></pre>
<p>Note about tooltip offset. Leaflet takes two options in consideration
for computing tooltip offseting:</p>
<ul>
<li>the <code>offset</code> Tooltip option: it defaults to [0, 0], and it's specific to one tooltip.
Add a positive x offset to move the tooltip to the right, and a positive y offset to
move it to the bottom. Negatives will move to the left and top.</li>
<li>the <code>tooltipAnchor</code> Icon option: this will only be considered for Marker. You
should adapt this value if you use a custom icon.</li>
</ul>
</section>
</section><section>
<h3 id='tooltip-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltip-l-tooltip'>
<td><code><b>L.tooltip</b>(<nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>, <nobr><<a href='#layer'>Layer</a>></nobr> <i>source?</i>)</nobr></code></td>
<td>Instantiates a Tooltip object given an optional <code>options</code> object that describes its appearance and location and an optional <code>source</code> object that is used to tag the tooltip with a reference to the Layer to which it refers.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='tooltip-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltip-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'tooltipPane'</code></td>
<td><code>Map pane</code> where the tooltip will be added.</td>
</tr>
<tr id='tooltip-offset'>
<td><code><b>offset</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>Point(0, 0)</code></td>
<td>Optional offset of the tooltip position.</td>
</tr>
<tr id='tooltip-direction'>
<td><code><b>direction</b></code></td>
<td><code>String</code>
<td><code>'auto'</code></td>
<td>Direction where to open the tooltip. Possible values are: <code>right</code>, <code>left</code>,
<code>top</code>, <code>bottom</code>, <code>center</code>, <code>auto</code>.
<code>auto</code> will dynamicaly switch between <code>right</code> and <code>left</code> according to the tooltip
position on the map.</td>
</tr>
<tr id='tooltip-permanent'>
<td><code><b>permanent</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>Whether to open the tooltip permanently or only on mouseover.</td>
</tr>
<tr id='tooltip-sticky'>
<td><code><b>sticky</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If true, the tooltip will follow the mouse instead of being fixed at the feature center.</td>
</tr>
<tr id='tooltip-interactive'>
<td><code><b>interactive</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If true, the tooltip will listen to the feature events.</td>
</tr>
<tr id='tooltip-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>0.9</code></td>
<td>Tooltip container opacity.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#divoverlay'>DivOverlay</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltip-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>A custom CSS class name to assign to the popup.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltip-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltip-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='tooltip-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltip-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='tooltip-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltip-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='tooltip-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Methods</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltip-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='tooltip-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='tooltip-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='tooltip-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='tooltip-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltip-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='tooltip-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='tooltip-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='tooltip-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='tooltip-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='tooltip-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='tooltip-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='tooltip-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltip-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='tooltip-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='tooltip-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='tooltip-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='tooltip-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='tooltip-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='tooltip-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='tooltip-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltip-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='tooltip-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='tooltip-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='tooltip-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='tooltip-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='tooltip-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='tooltip-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='tooltip-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='tooltip-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='tooltip-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='tooltip-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='tooltip-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='tooltip-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='tooltip-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='tooltip-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='tooltip-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='tilelayer'>TileLayer</h2><p>Used to load and display tile layers on the map. Extends <a href="#gridlayer"><code>GridLayer</code></a>.</p>
<section>
<h3 id='tilelayer-example'>Usage example</h3>
<section >
<pre><code class="lang-js">L.tileLayer('http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar'}).addTo(map);
</code></pre>
</section><section >
<h4 id='tilelayer-url-template'>URL template</h4>
<p>A string of the following form:</p>
<pre><code>'http://{s}.somedomain.com/blabla/{z}/{x}/{y}{r}.png'
</code></pre><p>You can use custom keys in the template, which will be <a href="#util-template">evaluated</a> from TileLayer options, like this:</p>
<pre><code>L.tileLayer('http://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'});
</code></pre>
</section>
</section><section>
<h3 id='tilelayer-factory'>Creation</h3>
<section class='collapsable'>
<h4 id='tilelayer-extension-methods'>Extension methods</h4>
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-l-tilelayer'>
<td><code><b>L.tilelayer</b>(<nobr><String></nobr> <i>urlTemplate</i>, <nobr><<a href='#tilelayer-option'>TileLayer options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Instantiates a tile layer object given a <code>URL template</code> and optionally an options object.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='tilelayer-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-minzoom'>
<td><code><b>minZoom</b></code></td>
<td><code>Number</code>
<td><code>0</code></td>
<td>The minimum zoom level down to which this layer will be displayed (inclusive).</td>
</tr>
<tr id='tilelayer-maxzoom'>
<td><code><b>maxZoom</b></code></td>
<td><code>Number</code>
<td><code>18</code></td>
<td>The maximum zoom level up to which this layer will be displayed (inclusive).</td>
</tr>
<tr id='tilelayer-subdomains'>
<td><code><b>subdomains</b></code></td>
<td><code>String|String[]</code>
<td><code>'abc'</code></td>
<td>Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings.</td>
</tr>
<tr id='tilelayer-errortileurl'>
<td><code><b>errorTileUrl</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>URL to the tile image to show in place of the tile that failed to load.</td>
</tr>
<tr id='tilelayer-zoomoffset'>
<td><code><b>zoomOffset</b></code></td>
<td><code>Number</code>
<td><code>0</code></td>
<td>The zoom number used in tile URLs will be offset with this value.</td>
</tr>
<tr id='tilelayer-tms'>
<td><code><b>tms</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, inverses Y axis numbering for tiles (turn this on for <a href="https://en.wikipedia.org/wiki/Tile_Map_Service">TMS</a> services).</td>
</tr>
<tr id='tilelayer-zoomreverse'>
<td><code><b>zoomReverse</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If set to true, the zoom number used in tile URLs will be reversed (<code>maxZoom - zoom</code> instead of <code>zoom</code>)</td>
</tr>
<tr id='tilelayer-detectretina'>
<td><code><b>detectRetina</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code> and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.</td>
</tr>
<tr id='tilelayer-crossorigin'>
<td><code><b>crossOrigin</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If true, all tiles will have their crossOrigin attribute set to ''. This is needed if you want to access tile pixel data.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#gridlayer'>GridLayer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-tilesize'>
<td><code><b>tileSize</b></code></td>
<td><code>Number|Point</code>
<td><code>256</code></td>
<td>Width and height of tiles in the grid. Use a number if width and height are equal, or <code>L.point(width, height)</code> otherwise.</td>
</tr>
<tr id='tilelayer-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>Opacity of the tiles. Can be used in the <code>createTile()</code> function.</td>
</tr>
<tr id='tilelayer-updatewhenidle'>
<td><code><b>updateWhenIdle</b></code></td>
<td><code>Boolean</code>
<td><code>depends</code></td>
<td>If <code>false</code>, new tiles are loaded during panning, otherwise only after it (for better performance). <code>true</code> by default on mobile browsers, otherwise <code>false</code>.</td>
</tr>
<tr id='tilelayer-updatewhenzooming'>
<td><code><b>updateWhenZooming</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>By default, a smooth zoom animation (during a <a href="#map-touchzoom">touch zoom</a> or a <a href="#map-flyto"><code>flyTo()</code></a>) will update grid layers every integer zoom level. Setting this option to <code>false</code> will update the grid layer only when the smooth animation ends.</td>
</tr>
<tr id='tilelayer-updateinterval'>
<td><code><b>updateInterval</b></code></td>
<td><code>Number</code>
<td><code>200</code></td>
<td>Tiles will not update more than once every <code>updateInterval</code> milliseconds when panning.</td>
</tr>
<tr id='tilelayer-zindex'>
<td><code><b>zIndex</b></code></td>
<td><code>Number</code>
<td><code>1</code></td>
<td>The explicit zIndex of the tile layer.</td>
</tr>
<tr id='tilelayer-bounds'>
<td><code><b>bounds</b></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code>
<td><code>undefined</code></td>
<td>If set, tiles will only be loaded inside the set <a href="#latlngbounds"><code>LatLngBounds</code></a>.</td>
</tr>
<tr id='tilelayer-maxnativezoom'>
<td><code><b>maxNativeZoom</b></code></td>
<td><code>Number</code>
<td><code>undefined</code></td>
<td>Maximum zoom number the tile source has available. If it is specified,
the tiles on all zoom levels higher than <code>maxNativeZoom</code> will be loaded
from <code>maxNativeZoom</code> level and auto-scaled.</td>
</tr>
<tr id='tilelayer-minnativezoom'>
<td><code><b>minNativeZoom</b></code></td>
<td><code>Number</code>
<td><code>undefined</code></td>
<td>Minimum zoom number the tile source has available. If it is specified,
the tiles on all zoom levels lower than <code>minNativeZoom</code> will be loaded
from <code>minNativeZoom</code> level and auto-scaled.</td>
</tr>
<tr id='tilelayer-nowrap'>
<td><code><b>noWrap</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>Whether the layer is wrapped around the antimeridian. If <code>true</code>, the
GridLayer will only be displayed once at low zoom levels. Has no
effect when the <a href="#map-crs">map CRS</a> doesn't wrap around. Can be used
in combination with <a href="#gridlayer-bounds"><a href="#bounds"><code>bounds</code></a></a> to prevent requesting
tiles outside the CRS limits.</td>
</tr>
<tr id='tilelayer-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'tilePane'</code></td>
<td><code>Map pane</code> where the grid layer will be added.</td>
</tr>
<tr id='tilelayer-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>A custom class name to assign to the tile layer. Empty by default.</td>
</tr>
<tr id='tilelayer-keepbuffer'>
<td><code><b>keepBuffer</b></code></td>
<td><code>Number</code>
<td><code>2</code></td>
<td>When panning the map, keep this many rows and columns of tiles before unloading them.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#gridlayer'>GridLayer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-loading'>
<td><code><b>loading</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the grid layer starts loading tiles.</td>
</tr>
<tr id='tilelayer-tileunload'>
<td><code><b>tileunload</b>
<td><code><a href='#tileevent'>TileEvent</a></code></td>
<td>Fired when a tile is removed (e.g. when a tile goes off the screen).</td>
</tr>
<tr id='tilelayer-tileloadstart'>
<td><code><b>tileloadstart</b>
<td><code><a href='#tileevent'>TileEvent</a></code></td>
<td>Fired when a tile is requested and starts loading.</td>
</tr>
<tr id='tilelayer-tileerror'>
<td><code><b>tileerror</b>
<td><code><a href='#tileerrorevent'>TileErrorEvent</a></code></td>
<td>Fired when there is an error loading a tile.</td>
</tr>
<tr id='tilelayer-tileload'>
<td><code><b>tileload</b>
<td><code><a href='#tileevent'>TileEvent</a></code></td>
<td>Fired when a tile loads.</td>
</tr>
<tr id='tilelayer-load'>
<td><code><b>load</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the grid layer loaded all visible tiles.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='tilelayer-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='tilelayer-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='tilelayer-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='tilelayer-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-seturl'>
<td><code><b>setUrl</b>(<nobr><String></nobr> <i>url</i>, <nobr><Boolean></nobr> <i>noRedraw?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Updates the layer's URL template and redraws it (unless <code>noRedraw</code> is set to <code>true</code>).</p>
</td>
</tr>
<tr id='tilelayer-createtile'>
<td><code><b>createTile</b>(<nobr><Object></nobr> <i>coords</i>, <nobr><Function></nobr> <i>done?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Called only internally, overrides GridLayer's <a href="#gridlayer-createtile"><code>createTile()</code></a>
to return an <code><img></code> HTML element with the appropiate image URL given <code>coords</code>. The <code>done</code>
callback is called when the tile has been loaded.</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='tilelayer-extension-methods'>Extension methods</h4>
<div class='section-comments'>Layers extending <a href="#tilelayer"><code>TileLayer</code></a> might reimplement the following method.</div>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-gettileurl'>
<td><code><b>getTileUrl</b>(<nobr><Object></nobr> <i>coords</i>)</nobr></code></td>
<td><code>String</code></td>
<td><p>Called only internally, returns the URL for a tile given its coordinates.
Classes extending <a href="#tilelayer"><code>TileLayer</code></a> can override this function to provide custom tile URL naming schemes.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#gridlayer'>GridLayer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the tile layer to the top of all tile layers.</p>
</td>
</tr>
<tr id='tilelayer-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the tile layer to the bottom of all tile layers.</p>
</td>
</tr>
<tr id='tilelayer-getcontainer'>
<td><code><b>getContainer</b>()</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the HTML element that contains the tiles for this layer.</p>
</td>
</tr>
<tr id='tilelayer-setopacity'>
<td><code><b>setOpacity</b>(<nobr><Number></nobr> <i>opacity</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the <a href="#gridlayer-opacity">opacity</a> of the grid layer.</p>
</td>
</tr>
<tr id='tilelayer-setzindex'>
<td><code><b>setZIndex</b>(<nobr><Number></nobr> <i>zIndex</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the <a href="#gridlayer-zindex">zIndex</a> of the grid layer.</p>
</td>
</tr>
<tr id='tilelayer-isloading'>
<td><code><b>isLoading</b>()</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if any tile in the grid layer has not finished loading.</p>
</td>
</tr>
<tr id='tilelayer-redraw'>
<td><code><b>redraw</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Causes the layer to clear all the tiles and request them again.</p>
</td>
</tr>
<tr id='tilelayer-gettilesize'>
<td><code><b>getTileSize</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Normalizes the <a href="#gridlayer-tilesize">tileSize option</a> into a point. Used by the <code>createTile()</code> method.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='tilelayer-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='tilelayer-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='tilelayer-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='tilelayer-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='tilelayer-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='tilelayer-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='tilelayer-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='tilelayer-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='tilelayer-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='tilelayer-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='tilelayer-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='tilelayer-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='tilelayer-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='tilelayer-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='tilelayer-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='tilelayer-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='tilelayer-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='tilelayer-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='tilelayer-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='tilelayer-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='tilelayer-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='tilelayer-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='tilelayer-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='tilelayer-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='tilelayer-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='tilelayer-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='tilelayer-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='tilelayer-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='tilelayer-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='tilelayer-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='tilelayer-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='tilelayer-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='tilelayer-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='tilelayer-wms'>TileLayer.WMS</h2><p>Used to display <a href="https://en.wikipedia.org/wiki/Web_Map_Service">WMS</a> services as tile layers on the map. Extends <a href="#tilelayer"><code>TileLayer</code></a>.</p>
<section>
<h3 id='tilelayer-wms-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var nexrad = L.tileLayer.wms("http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi", {
layers: 'nexrad-n0r-900913',
format: 'image/png',
transparent: true,
attribution: "Weather data © 2012 IEM Nexrad"
});
</code></pre>
</section>
</section><section>
<h3 id='tilelayer-wms-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-l-tilelayer-wms'>
<td><code><b>L.tileLayer.wms</b>(<nobr><String></nobr> <i>baseUrl</i>, <nobr><<a href='#tilelayer-wms-option'>TileLayer.WMS options</a>></nobr> <i>options</i>)</nobr></code></td>
<td>Instantiates a WMS tile layer object given a base URL of the WMS service and a WMS parameters/options object.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='tilelayer-wms-option'>Options</h3>
<section >
<div class='section-comments'>If any custom options not documented here are used, they will be sent to the
WMS server as extra parameters in each request URL. This can be useful for
<a href="http://docs.geoserver.org/stable/en/user/services/wms/vendor.html">non-standard vendor WMS parameters</a>.</div>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-layers'>
<td><code><b>layers</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td><strong>(required)</strong> Comma-separated list of WMS layers to show.</td>
</tr>
<tr id='tilelayer-wms-styles'>
<td><code><b>styles</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>Comma-separated list of WMS styles.</td>
</tr>
<tr id='tilelayer-wms-format'>
<td><code><b>format</b></code></td>
<td><code>String</code>
<td><code>'image/jpeg'</code></td>
<td>WMS image format (use <code>'image/png'</code> for layers with transparency).</td>
</tr>
<tr id='tilelayer-wms-transparent'>
<td><code><b>transparent</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, the WMS service will return images with transparency.</td>
</tr>
<tr id='tilelayer-wms-version'>
<td><code><b>version</b></code></td>
<td><code>String</code>
<td><code>'1.1.1'</code></td>
<td>Version of the WMS service to use</td>
</tr>
<tr id='tilelayer-wms-crs'>
<td><code><b>crs</b></code></td>
<td><code><a href='#crs'>CRS</a></code>
<td><code>null</code></td>
<td>Coordinate Reference System to use for the WMS requests, defaults to
map CRS. Don't change this if you're not sure what it means.</td>
</tr>
<tr id='tilelayer-wms-uppercase'>
<td><code><b>uppercase</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, WMS request parameter keys will be uppercase.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#tilelayer'>TileLayer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-minzoom'>
<td><code><b>minZoom</b></code></td>
<td><code>Number</code>
<td><code>0</code></td>
<td>The minimum zoom level down to which this layer will be displayed (inclusive).</td>
</tr>
<tr id='tilelayer-wms-maxzoom'>
<td><code><b>maxZoom</b></code></td>
<td><code>Number</code>
<td><code>18</code></td>
<td>The maximum zoom level up to which this layer will be displayed (inclusive).</td>
</tr>
<tr id='tilelayer-wms-subdomains'>
<td><code><b>subdomains</b></code></td>
<td><code>String|String[]</code>
<td><code>'abc'</code></td>
<td>Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings.</td>
</tr>
<tr id='tilelayer-wms-errortileurl'>
<td><code><b>errorTileUrl</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>URL to the tile image to show in place of the tile that failed to load.</td>
</tr>
<tr id='tilelayer-wms-zoomoffset'>
<td><code><b>zoomOffset</b></code></td>
<td><code>Number</code>
<td><code>0</code></td>
<td>The zoom number used in tile URLs will be offset with this value.</td>
</tr>
<tr id='tilelayer-wms-tms'>
<td><code><b>tms</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, inverses Y axis numbering for tiles (turn this on for <a href="https://en.wikipedia.org/wiki/Tile_Map_Service">TMS</a> services).</td>
</tr>
<tr id='tilelayer-wms-zoomreverse'>
<td><code><b>zoomReverse</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If set to true, the zoom number used in tile URLs will be reversed (<code>maxZoom - zoom</code> instead of <code>zoom</code>)</td>
</tr>
<tr id='tilelayer-wms-detectretina'>
<td><code><b>detectRetina</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code> and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.</td>
</tr>
<tr id='tilelayer-wms-crossorigin'>
<td><code><b>crossOrigin</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If true, all tiles will have their crossOrigin attribute set to ''. This is needed if you want to access tile pixel data.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#gridlayer'>GridLayer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-tilesize'>
<td><code><b>tileSize</b></code></td>
<td><code>Number|Point</code>
<td><code>256</code></td>
<td>Width and height of tiles in the grid. Use a number if width and height are equal, or <code>L.point(width, height)</code> otherwise.</td>
</tr>
<tr id='tilelayer-wms-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>Opacity of the tiles. Can be used in the <code>createTile()</code> function.</td>
</tr>
<tr id='tilelayer-wms-updatewhenidle'>
<td><code><b>updateWhenIdle</b></code></td>
<td><code>Boolean</code>
<td><code>depends</code></td>
<td>If <code>false</code>, new tiles are loaded during panning, otherwise only after it (for better performance). <code>true</code> by default on mobile browsers, otherwise <code>false</code>.</td>
</tr>
<tr id='tilelayer-wms-updatewhenzooming'>
<td><code><b>updateWhenZooming</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>By default, a smooth zoom animation (during a <a href="#map-touchzoom">touch zoom</a> or a <a href="#map-flyto"><code>flyTo()</code></a>) will update grid layers every integer zoom level. Setting this option to <code>false</code> will update the grid layer only when the smooth animation ends.</td>
</tr>
<tr id='tilelayer-wms-updateinterval'>
<td><code><b>updateInterval</b></code></td>
<td><code>Number</code>
<td><code>200</code></td>
<td>Tiles will not update more than once every <code>updateInterval</code> milliseconds when panning.</td>
</tr>
<tr id='tilelayer-wms-zindex'>
<td><code><b>zIndex</b></code></td>
<td><code>Number</code>
<td><code>1</code></td>
<td>The explicit zIndex of the tile layer.</td>
</tr>
<tr id='tilelayer-wms-bounds'>
<td><code><b>bounds</b></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code>
<td><code>undefined</code></td>
<td>If set, tiles will only be loaded inside the set <a href="#latlngbounds"><code>LatLngBounds</code></a>.</td>
</tr>
<tr id='tilelayer-wms-maxnativezoom'>
<td><code><b>maxNativeZoom</b></code></td>
<td><code>Number</code>
<td><code>undefined</code></td>
<td>Maximum zoom number the tile source has available. If it is specified,
the tiles on all zoom levels higher than <code>maxNativeZoom</code> will be loaded
from <code>maxNativeZoom</code> level and auto-scaled.</td>
</tr>
<tr id='tilelayer-wms-minnativezoom'>
<td><code><b>minNativeZoom</b></code></td>
<td><code>Number</code>
<td><code>undefined</code></td>
<td>Minimum zoom number the tile source has available. If it is specified,
the tiles on all zoom levels lower than <code>minNativeZoom</code> will be loaded
from <code>minNativeZoom</code> level and auto-scaled.</td>
</tr>
<tr id='tilelayer-wms-nowrap'>
<td><code><b>noWrap</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>Whether the layer is wrapped around the antimeridian. If <code>true</code>, the
GridLayer will only be displayed once at low zoom levels. Has no
effect when the <a href="#map-crs">map CRS</a> doesn't wrap around. Can be used
in combination with <a href="#gridlayer-bounds"><a href="#bounds"><code>bounds</code></a></a> to prevent requesting
tiles outside the CRS limits.</td>
</tr>
<tr id='tilelayer-wms-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'tilePane'</code></td>
<td><code>Map pane</code> where the grid layer will be added.</td>
</tr>
<tr id='tilelayer-wms-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>A custom class name to assign to the tile layer. Empty by default.</td>
</tr>
<tr id='tilelayer-wms-keepbuffer'>
<td><code><b>keepBuffer</b></code></td>
<td><code>Number</code>
<td><code>2</code></td>
<td>When panning the map, keep this many rows and columns of tiles before unloading them.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#gridlayer'>GridLayer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-loading'>
<td><code><b>loading</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the grid layer starts loading tiles.</td>
</tr>
<tr id='tilelayer-wms-tileunload'>
<td><code><b>tileunload</b>
<td><code><a href='#tileevent'>TileEvent</a></code></td>
<td>Fired when a tile is removed (e.g. when a tile goes off the screen).</td>
</tr>
<tr id='tilelayer-wms-tileloadstart'>
<td><code><b>tileloadstart</b>
<td><code><a href='#tileevent'>TileEvent</a></code></td>
<td>Fired when a tile is requested and starts loading.</td>
</tr>
<tr id='tilelayer-wms-tileerror'>
<td><code><b>tileerror</b>
<td><code><a href='#tileerrorevent'>TileErrorEvent</a></code></td>
<td>Fired when there is an error loading a tile.</td>
</tr>
<tr id='tilelayer-wms-tileload'>
<td><code><b>tileload</b>
<td><code><a href='#tileevent'>TileEvent</a></code></td>
<td>Fired when a tile loads.</td>
</tr>
<tr id='tilelayer-wms-load'>
<td><code><b>load</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the grid layer loaded all visible tiles.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='tilelayer-wms-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='tilelayer-wms-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='tilelayer-wms-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='tilelayer-wms-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-setparams'>
<td><code><b>setParams</b>(<nobr><Object></nobr> <i>params</i>, <nobr><Boolean></nobr> <i>noRedraw?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Merges an object with the new parameters and re-requests tiles on the current screen (unless <code>noRedraw</code> was set to true).</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#tilelayer'>TileLayer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-seturl'>
<td><code><b>setUrl</b>(<nobr><String></nobr> <i>url</i>, <nobr><Boolean></nobr> <i>noRedraw?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Updates the layer's URL template and redraws it (unless <code>noRedraw</code> is set to <code>true</code>).</p>
</td>
</tr>
<tr id='tilelayer-wms-createtile'>
<td><code><b>createTile</b>(<nobr><Object></nobr> <i>coords</i>, <nobr><Function></nobr> <i>done?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Called only internally, overrides GridLayer's <a href="#gridlayer-createtile"><code>createTile()</code></a>
to return an <code><img></code> HTML element with the appropiate image URL given <code>coords</code>. The <code>done</code>
callback is called when the tile has been loaded.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#gridlayer'>GridLayer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the tile layer to the top of all tile layers.</p>
</td>
</tr>
<tr id='tilelayer-wms-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the tile layer to the bottom of all tile layers.</p>
</td>
</tr>
<tr id='tilelayer-wms-getcontainer'>
<td><code><b>getContainer</b>()</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the HTML element that contains the tiles for this layer.</p>
</td>
</tr>
<tr id='tilelayer-wms-setopacity'>
<td><code><b>setOpacity</b>(<nobr><Number></nobr> <i>opacity</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the <a href="#gridlayer-opacity">opacity</a> of the grid layer.</p>
</td>
</tr>
<tr id='tilelayer-wms-setzindex'>
<td><code><b>setZIndex</b>(<nobr><Number></nobr> <i>zIndex</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the <a href="#gridlayer-zindex">zIndex</a> of the grid layer.</p>
</td>
</tr>
<tr id='tilelayer-wms-isloading'>
<td><code><b>isLoading</b>()</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if any tile in the grid layer has not finished loading.</p>
</td>
</tr>
<tr id='tilelayer-wms-redraw'>
<td><code><b>redraw</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Causes the layer to clear all the tiles and request them again.</p>
</td>
</tr>
<tr id='tilelayer-wms-gettilesize'>
<td><code><b>getTileSize</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Normalizes the <a href="#gridlayer-tilesize">tileSize option</a> into a point. Used by the <code>createTile()</code> method.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='tilelayer-wms-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='tilelayer-wms-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='tilelayer-wms-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='tilelayer-wms-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='tilelayer-wms-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='tilelayer-wms-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='tilelayer-wms-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='tilelayer-wms-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='tilelayer-wms-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='tilelayer-wms-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='tilelayer-wms-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='tilelayer-wms-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='tilelayer-wms-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='tilelayer-wms-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='tilelayer-wms-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='tilelayer-wms-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='tilelayer-wms-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='tilelayer-wms-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tilelayer-wms-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='tilelayer-wms-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='tilelayer-wms-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='tilelayer-wms-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='tilelayer-wms-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='tilelayer-wms-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='tilelayer-wms-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='tilelayer-wms-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='tilelayer-wms-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='tilelayer-wms-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='tilelayer-wms-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='tilelayer-wms-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='tilelayer-wms-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='tilelayer-wms-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='tilelayer-wms-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='tilelayer-wms-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='imageoverlay'>ImageOverlay</h2><p>Used to load and display a single image over specific bounds of the map. Extends <a href="#layer"><code>Layer</code></a>.</p>
<section>
<h3 id='imageoverlay-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var imageUrl = 'http://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg',
imageBounds = [[40.712216, -74.22655], [40.773941, -74.12544]];
L.imageOverlay(imageUrl, imageBounds).addTo(map);
</code></pre>
</section>
</section><section>
<h3 id='imageoverlay-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-l-imageoverlay'>
<td><code><b>L.imageOverlay</b>(<nobr><String></nobr> <i>imageUrl</i>, <nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>bounds</i>, <nobr><<a href='#imageoverlay-option'>ImageOverlay options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Instantiates an image overlay object given the URL of the image and the
geographical bounds it is tied to.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='imageoverlay-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>The opacity of the image overlay.</td>
</tr>
<tr id='imageoverlay-alt'>
<td><code><b>alt</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>Text for the <code>alt</code> attribute of the image (useful for accessibility).</td>
</tr>
<tr id='imageoverlay-interactive'>
<td><code><b>interactive</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, the image overlay will emit <a href="#interactive-layer">mouse events</a> when clicked or hovered.</td>
</tr>
<tr id='imageoverlay-crossorigin'>
<td><code><b>crossOrigin</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If true, the image will have its crossOrigin attribute set to ''. This is needed if you want to access image pixel data.</td>
</tr>
<tr id='imageoverlay-erroroverlayurl'>
<td><code><b>errorOverlayUrl</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>URL to the overlay image to show in place of the overlay that failed to load.</td>
</tr>
<tr id='imageoverlay-zindex'>
<td><code><b>zIndex</b></code></td>
<td><code>Number</code>
<td><code>1</code></td>
<td>The explicit <a href="https://developer.mozilla.org/docs/Web/CSS/CSS_Positioning/Understanding_z_index">zIndex</a> of the tile layer.</td>
</tr>
<tr id='imageoverlay-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>A custom class name to assign to the image. Empty by default.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-bubblingmouseevents'>
<td><code><b>bubblingMouseEvents</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>When <code>true</code>, a mouse event on this layer will trigger the same event on the map
(unless <a href="#domevent-stoppropagation"><code>L.DomEvent.stopPropagation</code></a> is used).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='imageoverlay-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='imageoverlay-event'>Events</h3>
<section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-load'>
<td><code><b>load</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the ImageOverlay layer has loaded its image</td>
</tr>
<tr id='imageoverlay-error'>
<td><code><b>error</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the ImageOverlay layer has loaded its image</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Mouse events inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-click'>
<td><code><b>click</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the layer.</td>
</tr>
<tr id='imageoverlay-dblclick'>
<td><code><b>dblclick</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the layer.</td>
</tr>
<tr id='imageoverlay-mousedown'>
<td><code><b>mousedown</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the layer.</td>
</tr>
<tr id='imageoverlay-mouseover'>
<td><code><b>mouseover</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse enters the layer.</td>
</tr>
<tr id='imageoverlay-mouseout'>
<td><code><b>mouseout</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse leaves the layer.</td>
</tr>
<tr id='imageoverlay-contextmenu'>
<td><code><b>contextmenu</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user right-clicks on the layer, prevents
default browser context menu from showing if there are listeners on
this event. Also fired on mobile when the user holds a single touch
for a second (also called long press).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='imageoverlay-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='imageoverlay-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='imageoverlay-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='imageoverlay-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-setopacity'>
<td><code><b>setOpacity</b>(<nobr><Number></nobr> <i>opacity</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the opacity of the overlay.</p>
</td>
</tr>
<tr id='imageoverlay-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the top of all overlays.</p>
</td>
</tr>
<tr id='imageoverlay-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the bottom of all overlays.</p>
</td>
</tr>
<tr id='imageoverlay-seturl'>
<td><code><b>setUrl</b>(<nobr><String></nobr> <i>url</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the URL of the image.</p>
</td>
</tr>
<tr id='imageoverlay-setbounds'>
<td><code><b>setBounds</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>bounds</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Update the bounds that this ImageOverlay covers
Changes the <a href="#imageoverlay-zindex">zIndex</a> of the image overlay.</p>
</td>
</tr>
<tr id='imageoverlay-getbounds'>
<td><code><b>getBounds</b>()</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Get the bounds that this ImageOverlay covers</p>
</td>
</tr>
<tr id='imageoverlay-getelement'>
<td><code><b>getElement</b>()</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the instance of <a href="https://developer.mozilla.org/docs/Web/API/HTMLImageElement"><code>HTMLImageElement</code></a>
used by this overlay.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='imageoverlay-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='imageoverlay-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='imageoverlay-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='imageoverlay-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='imageoverlay-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='imageoverlay-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='imageoverlay-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='imageoverlay-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='imageoverlay-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='imageoverlay-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='imageoverlay-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='imageoverlay-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='imageoverlay-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='imageoverlay-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='imageoverlay-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='imageoverlay-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='imageoverlay-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='imageoverlay-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='imageoverlay-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='imageoverlay-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='imageoverlay-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='imageoverlay-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='imageoverlay-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='imageoverlay-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='imageoverlay-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='imageoverlay-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='imageoverlay-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='imageoverlay-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='imageoverlay-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='imageoverlay-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='imageoverlay-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='imageoverlay-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='imageoverlay-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='imageoverlay-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='videooverlay'>VideoOverlay</h2><p>Used to load and display a video player over specific bounds of the map. Extends <a href="#imageoverlay"><code>ImageOverlay</code></a>.
A video overlay uses the <a href="https://developer.mozilla.org/docs/Web/HTML/Element/video"><code><video></code></a>
HTML5 element.</p>
<section>
<h3 id='videooverlay-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var videoUrl = 'https://www.mapbox.com/bites/00188/patricia_nasa.webm',
imageBounds = [[ 32, -130], [ 13, -100]];
L.imageOverlay(imageUrl, imageBounds).addTo(map);
</code></pre>
</section>
</section><section>
<h3 id='videooverlay-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-l-videooverlay'>
<td><code><b>L.videoOverlay</b>(<nobr><String|Array></nobr> <i>videoUrl</i>, <nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>bounds</i>, <nobr><<a href='#videooverlay-option'>VideoOverlay options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Instantiates an image overlay object given the URL of the video (or array of URLs) and the
geographical bounds it is tied to.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='videooverlay-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-autoplay'>
<td><code><b>autoplay</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether the video starts playing automatically when loaded.</td>
</tr>
<tr id='videooverlay-loop'>
<td><code><b>loop</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether the video will loop back to the beginning when played.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#imageoverlay'>ImageOverlay</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>The opacity of the image overlay.</td>
</tr>
<tr id='videooverlay-alt'>
<td><code><b>alt</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>Text for the <code>alt</code> attribute of the image (useful for accessibility).</td>
</tr>
<tr id='videooverlay-interactive'>
<td><code><b>interactive</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, the image overlay will emit <a href="#interactive-layer">mouse events</a> when clicked or hovered.</td>
</tr>
<tr id='videooverlay-crossorigin'>
<td><code><b>crossOrigin</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If true, the image will have its crossOrigin attribute set to ''. This is needed if you want to access image pixel data.</td>
</tr>
<tr id='videooverlay-erroroverlayurl'>
<td><code><b>errorOverlayUrl</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>URL to the overlay image to show in place of the overlay that failed to load.</td>
</tr>
<tr id='videooverlay-zindex'>
<td><code><b>zIndex</b></code></td>
<td><code>Number</code>
<td><code>1</code></td>
<td>The explicit <a href="https://developer.mozilla.org/docs/Web/CSS/CSS_Positioning/Understanding_z_index">zIndex</a> of the tile layer.</td>
</tr>
<tr id='videooverlay-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>A custom class name to assign to the image. Empty by default.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-bubblingmouseevents'>
<td><code><b>bubblingMouseEvents</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>When <code>true</code>, a mouse event on this layer will trigger the same event on the map
(unless <a href="#domevent-stoppropagation"><code>L.DomEvent.stopPropagation</code></a> is used).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='videooverlay-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='videooverlay-event'>Events</h3>
<section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-load'>
<td><code><b>load</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the video has finished loading the first frame</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#imageoverlay'>ImageOverlay</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-error'>
<td><code><b>error</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the ImageOverlay layer has loaded its image</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Mouse events inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-click'>
<td><code><b>click</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the layer.</td>
</tr>
<tr id='videooverlay-dblclick'>
<td><code><b>dblclick</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the layer.</td>
</tr>
<tr id='videooverlay-mousedown'>
<td><code><b>mousedown</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the layer.</td>
</tr>
<tr id='videooverlay-mouseover'>
<td><code><b>mouseover</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse enters the layer.</td>
</tr>
<tr id='videooverlay-mouseout'>
<td><code><b>mouseout</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse leaves the layer.</td>
</tr>
<tr id='videooverlay-contextmenu'>
<td><code><b>contextmenu</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user right-clicks on the layer, prevents
default browser context menu from showing if there are listeners on
this event. Also fired on mobile when the user holds a single touch
for a second (also called long press).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='videooverlay-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='videooverlay-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='videooverlay-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='videooverlay-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-getelement'>
<td><code><b>getElement</b>()</nobr></code></td>
<td><code>HTMLVideoElement</code></td>
<td><p>Returns the instance of <a href="https://developer.mozilla.org/docs/Web/API/HTMLVideoElement"><code>HTMLVideoElement</code></a>
used by this overlay.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#imageoverlay'>ImageOverlay</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-setopacity'>
<td><code><b>setOpacity</b>(<nobr><Number></nobr> <i>opacity</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the opacity of the overlay.</p>
</td>
</tr>
<tr id='videooverlay-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the top of all overlays.</p>
</td>
</tr>
<tr id='videooverlay-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the bottom of all overlays.</p>
</td>
</tr>
<tr id='videooverlay-seturl'>
<td><code><b>setUrl</b>(<nobr><String></nobr> <i>url</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the URL of the image.</p>
</td>
</tr>
<tr id='videooverlay-setbounds'>
<td><code><b>setBounds</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>bounds</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Update the bounds that this ImageOverlay covers
Changes the <a href="#imageoverlay-zindex">zIndex</a> of the image overlay.</p>
</td>
</tr>
<tr id='videooverlay-getbounds'>
<td><code><b>getBounds</b>()</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Get the bounds that this ImageOverlay covers</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='videooverlay-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='videooverlay-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='videooverlay-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='videooverlay-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='videooverlay-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='videooverlay-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='videooverlay-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='videooverlay-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='videooverlay-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='videooverlay-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='videooverlay-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='videooverlay-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='videooverlay-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='videooverlay-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='videooverlay-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='videooverlay-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='videooverlay-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='videooverlay-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='videooverlay-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='videooverlay-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='videooverlay-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='videooverlay-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='videooverlay-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='videooverlay-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='videooverlay-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='videooverlay-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='videooverlay-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='videooverlay-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='videooverlay-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='videooverlay-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='videooverlay-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='videooverlay-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='videooverlay-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='videooverlay-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='path'>Path</h2><p>An abstract class that contains options and constants shared between vector
overlays (Polygon, Polyline, Circle). Do not use it directly. Extends <a href="#layer"><code>Layer</code></a>.</p>
<section>
<h3 id='path-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-l-svg'>
<td><code><b>L.svg</b>(<nobr><<a href='#renderer-option'>Renderer options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Creates a SVG renderer with the given options.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='path-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-stroke'>
<td><code><b>stroke</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether to draw stroke along the path. Set it to <code>false</code> to disable borders on polygons or circles.</td>
</tr>
<tr id='path-color'>
<td><code><b>color</b></code></td>
<td><code>String</code>
<td><code>'#3388ff'</code></td>
<td>Stroke color</td>
</tr>
<tr id='path-weight'>
<td><code><b>weight</b></code></td>
<td><code>Number</code>
<td><code>3</code></td>
<td>Stroke width in pixels</td>
</tr>
<tr id='path-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>Stroke opacity</td>
</tr>
<tr id='path-linecap'>
<td><code><b>lineCap</b></code></td>
<td><code>String</code>
<td><code>'round'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linecap">shape to be used at the end</a> of the stroke.</td>
</tr>
<tr id='path-linejoin'>
<td><code><b>lineJoin</b></code></td>
<td><code>String</code>
<td><code>'round'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linejoin">shape to be used at the corners</a> of the stroke.</td>
</tr>
<tr id='path-dasharray'>
<td><code><b>dashArray</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>A string that defines the stroke <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dasharray">dash pattern</a>. Doesn't work on <a href="#canvas"><code>Canvas</code></a>-powered layers in <a href="https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility">some old browsers</a>.</td>
</tr>
<tr id='path-dashoffset'>
<td><code><b>dashOffset</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>A string that defines the <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dashoffset">distance into the dash pattern to start the dash</a>. Doesn't work on <a href="#canvas"><code>Canvas</code></a>-powered layers in <a href="https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility">some old browsers</a>.</td>
</tr>
<tr id='path-fill'>
<td><code><b>fill</b></code></td>
<td><code>Boolean</code>
<td><code>depends</code></td>
<td>Whether to fill the path with color. Set it to <code>false</code> to disable filling on polygons or circles.</td>
</tr>
<tr id='path-fillcolor'>
<td><code><b>fillColor</b></code></td>
<td><code>String</code>
<td><code>*</code></td>
<td>Fill color. Defaults to the value of the <a href="#path-color"><code>color</code></a> option</td>
</tr>
<tr id='path-fillopacity'>
<td><code><b>fillOpacity</b></code></td>
<td><code>Number</code>
<td><code>0.2</code></td>
<td>Fill opacity.</td>
</tr>
<tr id='path-fillrule'>
<td><code><b>fillRule</b></code></td>
<td><code>String</code>
<td><code>'evenodd'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/fill-rule">how the inside of a shape</a> is determined.</td>
</tr>
<tr id='path-bubblingmouseevents'>
<td><code><b>bubblingMouseEvents</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>When <code>true</code>, a mouse event on this path will trigger the same event on the map
(unless <a href="#domevent-stoppropagation"><code>L.DomEvent.stopPropagation</code></a> is used).</td>
</tr>
<tr id='path-renderer'>
<td><code><b>renderer</b></code></td>
<td><code><a href='#renderer'>Renderer</a></code>
<td><code></code></td>
<td>Use this specific instance of <a href="#renderer"><code>Renderer</code></a> for this path. Takes
precedence over the map's <a href="#map-renderer">default renderer</a>.</td>
</tr>
<tr id='path-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>Custom class name set on an element. Only for SVG renderer.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-interactive'>
<td><code><b>interactive</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>If <code>false</code>, the layer will not emit mouse events and will act as a part of the underlying map.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='path-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Mouse events inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-click'>
<td><code><b>click</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the layer.</td>
</tr>
<tr id='path-dblclick'>
<td><code><b>dblclick</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the layer.</td>
</tr>
<tr id='path-mousedown'>
<td><code><b>mousedown</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the layer.</td>
</tr>
<tr id='path-mouseover'>
<td><code><b>mouseover</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse enters the layer.</td>
</tr>
<tr id='path-mouseout'>
<td><code><b>mouseout</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse leaves the layer.</td>
</tr>
<tr id='path-contextmenu'>
<td><code><b>contextmenu</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user right-clicks on the layer, prevents
default browser context menu from showing if there are listeners on
this event. Also fired on mobile when the user holds a single touch
for a second (also called long press).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='path-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='path-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='path-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='path-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-redraw'>
<td><code><b>redraw</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.</p>
</td>
</tr>
<tr id='path-setstyle'>
<td><code><b>setStyle</b>(<nobr><<a href='#path-option'>Path options</a>></nobr> <i>style</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the appearance of a Path based on the options in the <a href="#path-option"><code>Path options</code></a> object.</p>
</td>
</tr>
<tr id='path-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the top of all path layers.</p>
</td>
</tr>
<tr id='path-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the bottom of all path layers.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='path-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='path-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='path-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='path-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='path-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='path-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='path-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='path-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='path-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='path-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='path-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='path-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='path-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='path-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='path-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='path-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='path-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='path-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='path-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='path-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='path-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='path-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='path-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='path-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='path-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='path-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='path-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='path-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='path-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='path-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='path-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='path-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='path-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='path-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='polyline'>Polyline</h2><p>A class for drawing polyline overlays on a map. Extends <a href="#path"><code>Path</code></a>.</p>
<section>
<h3 id='polyline-example'>Usage example</h3>
<section >
<pre><code class="lang-js">// create a red polyline from an array of LatLng points
var latlngs = [
[45.51, -122.68],
[37.77, -122.43],
[34.04, -118.2]
];
var polyline = L.polyline(latlngs, {color: 'red'}).addTo(map);
// zoom the map to the polyline
map.fitBounds(polyline.getBounds());
</code></pre>
<p>You can also pass a multi-dimensional array to represent a <code>MultiPolyline</code> shape:</p>
<pre><code class="lang-js">// create a red polyline from an array of arrays of LatLng points
var latlngs = [
[[45.51, -122.68],
[37.77, -122.43],
[34.04, -118.2]],
[[40.78, -73.91],
[41.83, -87.62],
[32.76, -96.72]]
];
</code></pre>
</section>
</section><section>
<h3 id='polyline-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-l-polyline'>
<td><code><b>L.polyline</b>(<nobr><LatLng[]></nobr> <i>latlngs</i>, <nobr><<a href='#polyline-option'>Polyline options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Instantiates a polyline object given an array of geographical points and
optionally an options object. You can create a <a href="#polyline"><code>Polyline</code></a> object with
multiple separate lines (<code>MultiPolyline</code>) by passing an array of arrays
of geographic points.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='polyline-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-smoothfactor'>
<td><code><b>smoothFactor</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>How much to simplify the polyline on each zoom level. More means
better performance and smoother look, and less means more accurate representation.</td>
</tr>
<tr id='polyline-noclip'>
<td><code><b>noClip</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>Disable polyline clipping.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#path'>Path</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-stroke'>
<td><code><b>stroke</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether to draw stroke along the path. Set it to <code>false</code> to disable borders on polygons or circles.</td>
</tr>
<tr id='polyline-color'>
<td><code><b>color</b></code></td>
<td><code>String</code>
<td><code>'#3388ff'</code></td>
<td>Stroke color</td>
</tr>
<tr id='polyline-weight'>
<td><code><b>weight</b></code></td>
<td><code>Number</code>
<td><code>3</code></td>
<td>Stroke width in pixels</td>
</tr>
<tr id='polyline-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>Stroke opacity</td>
</tr>
<tr id='polyline-linecap'>
<td><code><b>lineCap</b></code></td>
<td><code>String</code>
<td><code>'round'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linecap">shape to be used at the end</a> of the stroke.</td>
</tr>
<tr id='polyline-linejoin'>
<td><code><b>lineJoin</b></code></td>
<td><code>String</code>
<td><code>'round'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linejoin">shape to be used at the corners</a> of the stroke.</td>
</tr>
<tr id='polyline-dasharray'>
<td><code><b>dashArray</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>A string that defines the stroke <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dasharray">dash pattern</a>. Doesn't work on <a href="#canvas"><code>Canvas</code></a>-powered layers in <a href="https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility">some old browsers</a>.</td>
</tr>
<tr id='polyline-dashoffset'>
<td><code><b>dashOffset</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>A string that defines the <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dashoffset">distance into the dash pattern to start the dash</a>. Doesn't work on <a href="#canvas"><code>Canvas</code></a>-powered layers in <a href="https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility">some old browsers</a>.</td>
</tr>
<tr id='polyline-fill'>
<td><code><b>fill</b></code></td>
<td><code>Boolean</code>
<td><code>depends</code></td>
<td>Whether to fill the path with color. Set it to <code>false</code> to disable filling on polygons or circles.</td>
</tr>
<tr id='polyline-fillcolor'>
<td><code><b>fillColor</b></code></td>
<td><code>String</code>
<td><code>*</code></td>
<td>Fill color. Defaults to the value of the <a href="#path-color"><code>color</code></a> option</td>
</tr>
<tr id='polyline-fillopacity'>
<td><code><b>fillOpacity</b></code></td>
<td><code>Number</code>
<td><code>0.2</code></td>
<td>Fill opacity.</td>
</tr>
<tr id='polyline-fillrule'>
<td><code><b>fillRule</b></code></td>
<td><code>String</code>
<td><code>'evenodd'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/fill-rule">how the inside of a shape</a> is determined.</td>
</tr>
<tr id='polyline-bubblingmouseevents'>
<td><code><b>bubblingMouseEvents</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>When <code>true</code>, a mouse event on this path will trigger the same event on the map
(unless <a href="#domevent-stoppropagation"><code>L.DomEvent.stopPropagation</code></a> is used).</td>
</tr>
<tr id='polyline-renderer'>
<td><code><b>renderer</b></code></td>
<td><code><a href='#renderer'>Renderer</a></code>
<td><code></code></td>
<td>Use this specific instance of <a href="#renderer"><code>Renderer</code></a> for this path. Takes
precedence over the map's <a href="#map-renderer">default renderer</a>.</td>
</tr>
<tr id='polyline-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>Custom class name set on an element. Only for SVG renderer.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-interactive'>
<td><code><b>interactive</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>If <code>false</code>, the layer will not emit mouse events and will act as a part of the underlying map.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='polyline-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Mouse events inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-click'>
<td><code><b>click</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the layer.</td>
</tr>
<tr id='polyline-dblclick'>
<td><code><b>dblclick</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the layer.</td>
</tr>
<tr id='polyline-mousedown'>
<td><code><b>mousedown</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the layer.</td>
</tr>
<tr id='polyline-mouseover'>
<td><code><b>mouseover</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse enters the layer.</td>
</tr>
<tr id='polyline-mouseout'>
<td><code><b>mouseout</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse leaves the layer.</td>
</tr>
<tr id='polyline-contextmenu'>
<td><code><b>contextmenu</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user right-clicks on the layer, prevents
default browser context menu from showing if there are listeners on
this event. Also fired on mobile when the user holds a single touch
for a second (also called long press).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='polyline-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='polyline-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='polyline-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='polyline-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-togeojson'>
<td><code><b>toGeoJSON</b>()</nobr></code></td>
<td><code>Object</code></td>
<td><p>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON"><a href="#geojson"><code>GeoJSON</code></a></a> representation of the polyline (as a GeoJSON <code>LineString</code> or <code>MultiLineString</code> Feature).</p>
</td>
</tr>
<tr id='polyline-getlatlngs'>
<td><code><b>getLatLngs</b>()</nobr></code></td>
<td><code>LatLng[]</code></td>
<td><p>Returns an array of the points in the path, or nested arrays of points in case of multi-polyline.</p>
</td>
</tr>
<tr id='polyline-setlatlngs'>
<td><code><b>setLatLngs</b>(<nobr><LatLng[]></nobr> <i>latlngs</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Replaces all the points in the polyline with the given array of geographical points.</p>
</td>
</tr>
<tr id='polyline-isempty'>
<td><code><b>isEmpty</b>()</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the Polyline has no LatLngs.</p>
</td>
</tr>
<tr id='polyline-getcenter'>
<td><code><b>getCenter</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the center (<a href="http://en.wikipedia.org/wiki/Centroid">centroid</a>) of the polyline.</p>
</td>
</tr>
<tr id='polyline-getbounds'>
<td><code><b>getBounds</b>()</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Returns the <a href="#latlngbounds"><code>LatLngBounds</code></a> of the path.</p>
</td>
</tr>
<tr id='polyline-addlatlng'>
<td><code><b>addLatLng</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a given point to the polyline. By default, adds to the first ring of
the polyline in case of a multi-polyline, but can be overridden by passing
a specific ring as a LatLng array (that you can earlier access with <a href="#polyline-getlatlngs"><code>getLatLngs</code></a>).</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#path'>Path</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-redraw'>
<td><code><b>redraw</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.</p>
</td>
</tr>
<tr id='polyline-setstyle'>
<td><code><b>setStyle</b>(<nobr><<a href='#path-option'>Path options</a>></nobr> <i>style</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the appearance of a Path based on the options in the <a href="#path-option"><code>Path options</code></a> object.</p>
</td>
</tr>
<tr id='polyline-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the top of all path layers.</p>
</td>
</tr>
<tr id='polyline-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the bottom of all path layers.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='polyline-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='polyline-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='polyline-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='polyline-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='polyline-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='polyline-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='polyline-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='polyline-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='polyline-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='polyline-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='polyline-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='polyline-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='polyline-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='polyline-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='polyline-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='polyline-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='polyline-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='polyline-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyline-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='polyline-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='polyline-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='polyline-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='polyline-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='polyline-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='polyline-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='polyline-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='polyline-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='polyline-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='polyline-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='polyline-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='polyline-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='polyline-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='polyline-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='polyline-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='polygon'>Polygon</h2><p>A class for drawing polygon overlays on a map. Extends <a href="#polyline"><code>Polyline</code></a>.
Note that points you pass when creating a polygon shouldn't have an additional last point equal to the first one — it's better to filter out such points.</p>
<section>
<h3 id='polygon-example'>Usage example</h3>
<section >
<pre><code class="lang-js">// create a red polygon from an array of LatLng points
var latlngs = [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]];
var polygon = L.polygon(latlngs, {color: 'red'}).addTo(map);
// zoom the map to the polygon
map.fitBounds(polygon.getBounds());
</code></pre>
<p>You can also pass an array of arrays of latlngs, with the first array representing the outer shape and the other arrays representing holes in the outer shape:</p>
<pre><code class="lang-js">var latlngs = [
[[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring
[[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole
];
</code></pre>
<p>Additionally, you can pass a multi-dimensional array to represent a MultiPolygon shape.</p>
<pre><code class="lang-js">var latlngs = [
[ // first polygon
[[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring
[[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole
],
[ // second polygon
[[41, -111.03],[45, -111.04],[45, -104.05],[41, -104.05]]
]
];
</code></pre>
</section>
</section><section>
<h3 id='polygon-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-l-polygon'>
<td><code><b>L.polygon</b>(<nobr><LatLng[]></nobr> <i>latlngs</i>, <nobr><<a href='#polyline-option'>Polyline options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td></td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id=''>Options</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#polyline'>Polyline</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-smoothfactor'>
<td><code><b>smoothFactor</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>How much to simplify the polyline on each zoom level. More means
better performance and smoother look, and less means more accurate representation.</td>
</tr>
<tr id='polygon-noclip'>
<td><code><b>noClip</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>Disable polyline clipping.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#path'>Path</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-stroke'>
<td><code><b>stroke</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether to draw stroke along the path. Set it to <code>false</code> to disable borders on polygons or circles.</td>
</tr>
<tr id='polygon-color'>
<td><code><b>color</b></code></td>
<td><code>String</code>
<td><code>'#3388ff'</code></td>
<td>Stroke color</td>
</tr>
<tr id='polygon-weight'>
<td><code><b>weight</b></code></td>
<td><code>Number</code>
<td><code>3</code></td>
<td>Stroke width in pixels</td>
</tr>
<tr id='polygon-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>Stroke opacity</td>
</tr>
<tr id='polygon-linecap'>
<td><code><b>lineCap</b></code></td>
<td><code>String</code>
<td><code>'round'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linecap">shape to be used at the end</a> of the stroke.</td>
</tr>
<tr id='polygon-linejoin'>
<td><code><b>lineJoin</b></code></td>
<td><code>String</code>
<td><code>'round'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linejoin">shape to be used at the corners</a> of the stroke.</td>
</tr>
<tr id='polygon-dasharray'>
<td><code><b>dashArray</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>A string that defines the stroke <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dasharray">dash pattern</a>. Doesn't work on <a href="#canvas"><code>Canvas</code></a>-powered layers in <a href="https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility">some old browsers</a>.</td>
</tr>
<tr id='polygon-dashoffset'>
<td><code><b>dashOffset</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>A string that defines the <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dashoffset">distance into the dash pattern to start the dash</a>. Doesn't work on <a href="#canvas"><code>Canvas</code></a>-powered layers in <a href="https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility">some old browsers</a>.</td>
</tr>
<tr id='polygon-fill'>
<td><code><b>fill</b></code></td>
<td><code>Boolean</code>
<td><code>depends</code></td>
<td>Whether to fill the path with color. Set it to <code>false</code> to disable filling on polygons or circles.</td>
</tr>
<tr id='polygon-fillcolor'>
<td><code><b>fillColor</b></code></td>
<td><code>String</code>
<td><code>*</code></td>
<td>Fill color. Defaults to the value of the <a href="#path-color"><code>color</code></a> option</td>
</tr>
<tr id='polygon-fillopacity'>
<td><code><b>fillOpacity</b></code></td>
<td><code>Number</code>
<td><code>0.2</code></td>
<td>Fill opacity.</td>
</tr>
<tr id='polygon-fillrule'>
<td><code><b>fillRule</b></code></td>
<td><code>String</code>
<td><code>'evenodd'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/fill-rule">how the inside of a shape</a> is determined.</td>
</tr>
<tr id='polygon-bubblingmouseevents'>
<td><code><b>bubblingMouseEvents</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>When <code>true</code>, a mouse event on this path will trigger the same event on the map
(unless <a href="#domevent-stoppropagation"><code>L.DomEvent.stopPropagation</code></a> is used).</td>
</tr>
<tr id='polygon-renderer'>
<td><code><b>renderer</b></code></td>
<td><code><a href='#renderer'>Renderer</a></code>
<td><code></code></td>
<td>Use this specific instance of <a href="#renderer"><code>Renderer</code></a> for this path. Takes
precedence over the map's <a href="#map-renderer">default renderer</a>.</td>
</tr>
<tr id='polygon-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>Custom class name set on an element. Only for SVG renderer.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-interactive'>
<td><code><b>interactive</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>If <code>false</code>, the layer will not emit mouse events and will act as a part of the underlying map.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='polygon-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Mouse events inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-click'>
<td><code><b>click</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the layer.</td>
</tr>
<tr id='polygon-dblclick'>
<td><code><b>dblclick</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the layer.</td>
</tr>
<tr id='polygon-mousedown'>
<td><code><b>mousedown</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the layer.</td>
</tr>
<tr id='polygon-mouseover'>
<td><code><b>mouseover</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse enters the layer.</td>
</tr>
<tr id='polygon-mouseout'>
<td><code><b>mouseout</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse leaves the layer.</td>
</tr>
<tr id='polygon-contextmenu'>
<td><code><b>contextmenu</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user right-clicks on the layer, prevents
default browser context menu from showing if there are listeners on
this event. Also fired on mobile when the user holds a single touch
for a second (also called long press).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='polygon-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='polygon-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='polygon-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='polygon-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-togeojson'>
<td><code><b>toGeoJSON</b>()</nobr></code></td>
<td><code>Object</code></td>
<td><p>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON"><a href="#geojson"><code>GeoJSON</code></a></a> representation of the polygon (as a GeoJSON <a href="#polygon"><code>Polygon</code></a> or <code>MultiPolygon</code> Feature).</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#polyline'>Polyline</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-getlatlngs'>
<td><code><b>getLatLngs</b>()</nobr></code></td>
<td><code>LatLng[]</code></td>
<td><p>Returns an array of the points in the path, or nested arrays of points in case of multi-polyline.</p>
</td>
</tr>
<tr id='polygon-setlatlngs'>
<td><code><b>setLatLngs</b>(<nobr><LatLng[]></nobr> <i>latlngs</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Replaces all the points in the polyline with the given array of geographical points.</p>
</td>
</tr>
<tr id='polygon-isempty'>
<td><code><b>isEmpty</b>()</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the Polyline has no LatLngs.</p>
</td>
</tr>
<tr id='polygon-getcenter'>
<td><code><b>getCenter</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the center (<a href="http://en.wikipedia.org/wiki/Centroid">centroid</a>) of the polyline.</p>
</td>
</tr>
<tr id='polygon-getbounds'>
<td><code><b>getBounds</b>()</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Returns the <a href="#latlngbounds"><code>LatLngBounds</code></a> of the path.</p>
</td>
</tr>
<tr id='polygon-addlatlng'>
<td><code><b>addLatLng</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a given point to the polyline. By default, adds to the first ring of
the polyline in case of a multi-polyline, but can be overridden by passing
a specific ring as a LatLng array (that you can earlier access with <a href="#polyline-getlatlngs"><code>getLatLngs</code></a>).</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#path'>Path</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-redraw'>
<td><code><b>redraw</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.</p>
</td>
</tr>
<tr id='polygon-setstyle'>
<td><code><b>setStyle</b>(<nobr><<a href='#path-option'>Path options</a>></nobr> <i>style</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the appearance of a Path based on the options in the <a href="#path-option"><code>Path options</code></a> object.</p>
</td>
</tr>
<tr id='polygon-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the top of all path layers.</p>
</td>
</tr>
<tr id='polygon-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the bottom of all path layers.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='polygon-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='polygon-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='polygon-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='polygon-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='polygon-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='polygon-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='polygon-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='polygon-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='polygon-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='polygon-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='polygon-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='polygon-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='polygon-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='polygon-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='polygon-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='polygon-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='polygon-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='polygon-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polygon-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='polygon-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='polygon-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='polygon-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='polygon-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='polygon-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='polygon-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='polygon-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='polygon-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='polygon-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='polygon-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='polygon-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='polygon-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='polygon-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='polygon-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='polygon-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='rectangle'>Rectangle</h2><p>A class for drawing rectangle overlays on a map. Extends <a href="#polygon"><code>Polygon</code></a>.</p>
<section>
<h3 id='rectangle-example'>Usage example</h3>
<section >
<pre><code class="lang-js">// define rectangle geographical bounds
var bounds = [[54.559322, -5.767822], [56.1210604, -3.021240]];
// create an orange rectangle
L.rectangle(bounds, {color: "#ff7800", weight: 1}).addTo(map);
// zoom the map to the rectangle bounds
map.fitBounds(bounds);
</code></pre>
</section>
</section><section>
<h3 id='rectangle-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-l-rectangle'>
<td><code><b>L.rectangle</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>latLngBounds</i>, <nobr><<a href='#polyline-option'>Polyline options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td></td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id=''>Options</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#polyline'>Polyline</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-smoothfactor'>
<td><code><b>smoothFactor</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>How much to simplify the polyline on each zoom level. More means
better performance and smoother look, and less means more accurate representation.</td>
</tr>
<tr id='rectangle-noclip'>
<td><code><b>noClip</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>Disable polyline clipping.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#path'>Path</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-stroke'>
<td><code><b>stroke</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether to draw stroke along the path. Set it to <code>false</code> to disable borders on polygons or circles.</td>
</tr>
<tr id='rectangle-color'>
<td><code><b>color</b></code></td>
<td><code>String</code>
<td><code>'#3388ff'</code></td>
<td>Stroke color</td>
</tr>
<tr id='rectangle-weight'>
<td><code><b>weight</b></code></td>
<td><code>Number</code>
<td><code>3</code></td>
<td>Stroke width in pixels</td>
</tr>
<tr id='rectangle-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>Stroke opacity</td>
</tr>
<tr id='rectangle-linecap'>
<td><code><b>lineCap</b></code></td>
<td><code>String</code>
<td><code>'round'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linecap">shape to be used at the end</a> of the stroke.</td>
</tr>
<tr id='rectangle-linejoin'>
<td><code><b>lineJoin</b></code></td>
<td><code>String</code>
<td><code>'round'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linejoin">shape to be used at the corners</a> of the stroke.</td>
</tr>
<tr id='rectangle-dasharray'>
<td><code><b>dashArray</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>A string that defines the stroke <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dasharray">dash pattern</a>. Doesn't work on <a href="#canvas"><code>Canvas</code></a>-powered layers in <a href="https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility">some old browsers</a>.</td>
</tr>
<tr id='rectangle-dashoffset'>
<td><code><b>dashOffset</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>A string that defines the <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dashoffset">distance into the dash pattern to start the dash</a>. Doesn't work on <a href="#canvas"><code>Canvas</code></a>-powered layers in <a href="https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility">some old browsers</a>.</td>
</tr>
<tr id='rectangle-fill'>
<td><code><b>fill</b></code></td>
<td><code>Boolean</code>
<td><code>depends</code></td>
<td>Whether to fill the path with color. Set it to <code>false</code> to disable filling on polygons or circles.</td>
</tr>
<tr id='rectangle-fillcolor'>
<td><code><b>fillColor</b></code></td>
<td><code>String</code>
<td><code>*</code></td>
<td>Fill color. Defaults to the value of the <a href="#path-color"><code>color</code></a> option</td>
</tr>
<tr id='rectangle-fillopacity'>
<td><code><b>fillOpacity</b></code></td>
<td><code>Number</code>
<td><code>0.2</code></td>
<td>Fill opacity.</td>
</tr>
<tr id='rectangle-fillrule'>
<td><code><b>fillRule</b></code></td>
<td><code>String</code>
<td><code>'evenodd'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/fill-rule">how the inside of a shape</a> is determined.</td>
</tr>
<tr id='rectangle-bubblingmouseevents'>
<td><code><b>bubblingMouseEvents</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>When <code>true</code>, a mouse event on this path will trigger the same event on the map
(unless <a href="#domevent-stoppropagation"><code>L.DomEvent.stopPropagation</code></a> is used).</td>
</tr>
<tr id='rectangle-renderer'>
<td><code><b>renderer</b></code></td>
<td><code><a href='#renderer'>Renderer</a></code>
<td><code></code></td>
<td>Use this specific instance of <a href="#renderer"><code>Renderer</code></a> for this path. Takes
precedence over the map's <a href="#map-renderer">default renderer</a>.</td>
</tr>
<tr id='rectangle-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>Custom class name set on an element. Only for SVG renderer.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-interactive'>
<td><code><b>interactive</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>If <code>false</code>, the layer will not emit mouse events and will act as a part of the underlying map.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='rectangle-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Mouse events inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-click'>
<td><code><b>click</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the layer.</td>
</tr>
<tr id='rectangle-dblclick'>
<td><code><b>dblclick</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the layer.</td>
</tr>
<tr id='rectangle-mousedown'>
<td><code><b>mousedown</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the layer.</td>
</tr>
<tr id='rectangle-mouseover'>
<td><code><b>mouseover</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse enters the layer.</td>
</tr>
<tr id='rectangle-mouseout'>
<td><code><b>mouseout</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse leaves the layer.</td>
</tr>
<tr id='rectangle-contextmenu'>
<td><code><b>contextmenu</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user right-clicks on the layer, prevents
default browser context menu from showing if there are listeners on
this event. Also fired on mobile when the user holds a single touch
for a second (also called long press).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='rectangle-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='rectangle-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='rectangle-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='rectangle-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-setbounds'>
<td><code><b>setBounds</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>latLngBounds</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Redraws the rectangle with the passed bounds.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#polygon'>Polygon</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-togeojson'>
<td><code><b>toGeoJSON</b>()</nobr></code></td>
<td><code>Object</code></td>
<td><p>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON"><a href="#geojson"><code>GeoJSON</code></a></a> representation of the polygon (as a GeoJSON <a href="#polygon"><code>Polygon</code></a> or <code>MultiPolygon</code> Feature).</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#polyline'>Polyline</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-getlatlngs'>
<td><code><b>getLatLngs</b>()</nobr></code></td>
<td><code>LatLng[]</code></td>
<td><p>Returns an array of the points in the path, or nested arrays of points in case of multi-polyline.</p>
</td>
</tr>
<tr id='rectangle-setlatlngs'>
<td><code><b>setLatLngs</b>(<nobr><LatLng[]></nobr> <i>latlngs</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Replaces all the points in the polyline with the given array of geographical points.</p>
</td>
</tr>
<tr id='rectangle-isempty'>
<td><code><b>isEmpty</b>()</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the Polyline has no LatLngs.</p>
</td>
</tr>
<tr id='rectangle-getcenter'>
<td><code><b>getCenter</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the center (<a href="http://en.wikipedia.org/wiki/Centroid">centroid</a>) of the polyline.</p>
</td>
</tr>
<tr id='rectangle-getbounds'>
<td><code><b>getBounds</b>()</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Returns the <a href="#latlngbounds"><code>LatLngBounds</code></a> of the path.</p>
</td>
</tr>
<tr id='rectangle-addlatlng'>
<td><code><b>addLatLng</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a given point to the polyline. By default, adds to the first ring of
the polyline in case of a multi-polyline, but can be overridden by passing
a specific ring as a LatLng array (that you can earlier access with <a href="#polyline-getlatlngs"><code>getLatLngs</code></a>).</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#path'>Path</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-redraw'>
<td><code><b>redraw</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.</p>
</td>
</tr>
<tr id='rectangle-setstyle'>
<td><code><b>setStyle</b>(<nobr><<a href='#path-option'>Path options</a>></nobr> <i>style</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the appearance of a Path based on the options in the <a href="#path-option"><code>Path options</code></a> object.</p>
</td>
</tr>
<tr id='rectangle-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the top of all path layers.</p>
</td>
</tr>
<tr id='rectangle-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the bottom of all path layers.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='rectangle-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='rectangle-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='rectangle-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='rectangle-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='rectangle-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='rectangle-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='rectangle-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='rectangle-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='rectangle-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='rectangle-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='rectangle-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='rectangle-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='rectangle-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='rectangle-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='rectangle-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='rectangle-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='rectangle-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='rectangle-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='rectangle-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='rectangle-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='rectangle-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='rectangle-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='rectangle-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='rectangle-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='rectangle-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='rectangle-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='rectangle-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='rectangle-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='rectangle-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='rectangle-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='rectangle-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='rectangle-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='rectangle-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='rectangle-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='circle'>Circle</h2><p>A class for drawing circle overlays on a map. Extends <a href="#circlemarker"><code>CircleMarker</code></a>.
It's an approximation and starts to diverge from a real circle closer to poles (due to projection distortion).</p>
<section>
<h3 id='circle-example'>Usage example</h3>
<section >
<pre><code class="lang-js">L.circle([50.5, 30.5], {radius: 200}).addTo(map);
</code></pre>
</section>
</section><section>
<h3 id='circle-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-l-circle'>
<td><code><b>L.circle</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><<a href='#circle-option'>Circle options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Instantiates a circle object given a geographical point, and an options object
which contains the circle radius.</td>
</tr>
<tr id='circle-l-circle'>
<td><code><b>L.circle</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><Number></nobr> <i>radius</i>, <nobr><<a href='#circle-option'>Circle options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Obsolete way of instantiating a circle, for compatibility with 0.7.x code.
Do not use in new applications or plugins.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='circle-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-radius'>
<td><code><b>radius</b></code></td>
<td><code>Number</code>
<td><code></code></td>
<td>Radius of the circle, in meters.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#path'>Path</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-stroke'>
<td><code><b>stroke</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether to draw stroke along the path. Set it to <code>false</code> to disable borders on polygons or circles.</td>
</tr>
<tr id='circle-color'>
<td><code><b>color</b></code></td>
<td><code>String</code>
<td><code>'#3388ff'</code></td>
<td>Stroke color</td>
</tr>
<tr id='circle-weight'>
<td><code><b>weight</b></code></td>
<td><code>Number</code>
<td><code>3</code></td>
<td>Stroke width in pixels</td>
</tr>
<tr id='circle-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>Stroke opacity</td>
</tr>
<tr id='circle-linecap'>
<td><code><b>lineCap</b></code></td>
<td><code>String</code>
<td><code>'round'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linecap">shape to be used at the end</a> of the stroke.</td>
</tr>
<tr id='circle-linejoin'>
<td><code><b>lineJoin</b></code></td>
<td><code>String</code>
<td><code>'round'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linejoin">shape to be used at the corners</a> of the stroke.</td>
</tr>
<tr id='circle-dasharray'>
<td><code><b>dashArray</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>A string that defines the stroke <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dasharray">dash pattern</a>. Doesn't work on <a href="#canvas"><code>Canvas</code></a>-powered layers in <a href="https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility">some old browsers</a>.</td>
</tr>
<tr id='circle-dashoffset'>
<td><code><b>dashOffset</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>A string that defines the <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dashoffset">distance into the dash pattern to start the dash</a>. Doesn't work on <a href="#canvas"><code>Canvas</code></a>-powered layers in <a href="https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility">some old browsers</a>.</td>
</tr>
<tr id='circle-fill'>
<td><code><b>fill</b></code></td>
<td><code>Boolean</code>
<td><code>depends</code></td>
<td>Whether to fill the path with color. Set it to <code>false</code> to disable filling on polygons or circles.</td>
</tr>
<tr id='circle-fillcolor'>
<td><code><b>fillColor</b></code></td>
<td><code>String</code>
<td><code>*</code></td>
<td>Fill color. Defaults to the value of the <a href="#path-color"><code>color</code></a> option</td>
</tr>
<tr id='circle-fillopacity'>
<td><code><b>fillOpacity</b></code></td>
<td><code>Number</code>
<td><code>0.2</code></td>
<td>Fill opacity.</td>
</tr>
<tr id='circle-fillrule'>
<td><code><b>fillRule</b></code></td>
<td><code>String</code>
<td><code>'evenodd'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/fill-rule">how the inside of a shape</a> is determined.</td>
</tr>
<tr id='circle-bubblingmouseevents'>
<td><code><b>bubblingMouseEvents</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>When <code>true</code>, a mouse event on this path will trigger the same event on the map
(unless <a href="#domevent-stoppropagation"><code>L.DomEvent.stopPropagation</code></a> is used).</td>
</tr>
<tr id='circle-renderer'>
<td><code><b>renderer</b></code></td>
<td><code><a href='#renderer'>Renderer</a></code>
<td><code></code></td>
<td>Use this specific instance of <a href="#renderer"><code>Renderer</code></a> for this path. Takes
precedence over the map's <a href="#map-renderer">default renderer</a>.</td>
</tr>
<tr id='circle-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>Custom class name set on an element. Only for SVG renderer.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-interactive'>
<td><code><b>interactive</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>If <code>false</code>, the layer will not emit mouse events and will act as a part of the underlying map.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='circle-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Mouse events inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-click'>
<td><code><b>click</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the layer.</td>
</tr>
<tr id='circle-dblclick'>
<td><code><b>dblclick</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the layer.</td>
</tr>
<tr id='circle-mousedown'>
<td><code><b>mousedown</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the layer.</td>
</tr>
<tr id='circle-mouseover'>
<td><code><b>mouseover</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse enters the layer.</td>
</tr>
<tr id='circle-mouseout'>
<td><code><b>mouseout</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse leaves the layer.</td>
</tr>
<tr id='circle-contextmenu'>
<td><code><b>contextmenu</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user right-clicks on the layer, prevents
default browser context menu from showing if there are listeners on
this event. Also fired on mobile when the user holds a single touch
for a second (also called long press).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='circle-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='circle-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='circle-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='circle-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-setradius'>
<td><code><b>setRadius</b>(<nobr><Number></nobr> <i>radius</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the radius of a circle. Units are in meters.</p>
</td>
</tr>
<tr id='circle-getradius'>
<td><code><b>getRadius</b>()</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the current radius of a circle. Units are in meters.</p>
</td>
</tr>
<tr id='circle-getbounds'>
<td><code><b>getBounds</b>()</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Returns the <a href="#latlngbounds"><code>LatLngBounds</code></a> of the path.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#circlemarker'>CircleMarker</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-togeojson'>
<td><code><b>toGeoJSON</b>()</nobr></code></td>
<td><code>Object</code></td>
<td><p>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON"><a href="#geojson"><code>GeoJSON</code></a></a> representation of the circle marker (as a GeoJSON <a href="#point"><code>Point</code></a> Feature).</p>
</td>
</tr>
<tr id='circle-setlatlng'>
<td><code><b>setLatLng</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latLng</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the position of a circle marker to a new location.</p>
</td>
</tr>
<tr id='circle-getlatlng'>
<td><code><b>getLatLng</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the current geographical position of the circle marker</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#path'>Path</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-redraw'>
<td><code><b>redraw</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.</p>
</td>
</tr>
<tr id='circle-setstyle'>
<td><code><b>setStyle</b>(<nobr><<a href='#path-option'>Path options</a>></nobr> <i>style</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the appearance of a Path based on the options in the <a href="#path-option"><code>Path options</code></a> object.</p>
</td>
</tr>
<tr id='circle-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the top of all path layers.</p>
</td>
</tr>
<tr id='circle-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the bottom of all path layers.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='circle-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='circle-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='circle-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='circle-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='circle-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='circle-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='circle-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='circle-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='circle-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='circle-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='circle-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='circle-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='circle-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='circle-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='circle-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='circle-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='circle-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='circle-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circle-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='circle-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='circle-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='circle-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='circle-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='circle-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='circle-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='circle-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='circle-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='circle-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='circle-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='circle-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='circle-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='circle-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='circle-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='circle-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='circlemarker'>CircleMarker</h2><p>A circle of a fixed size with radius specified in pixels. Extends <a href="#path"><code>Path</code></a>.</p>
<section>
<h3 id='circlemarker-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-l-circlemarker'>
<td><code><b>L.circleMarker</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><<a href='#circlemarker-option'>CircleMarker options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Instantiates a circle marker object given a geographical point, and an optional options object.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='circlemarker-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-radius'>
<td><code><b>radius</b></code></td>
<td><code>Number</code>
<td><code>10</code></td>
<td>Radius of the circle marker, in pixels</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#path'>Path</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-stroke'>
<td><code><b>stroke</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>Whether to draw stroke along the path. Set it to <code>false</code> to disable borders on polygons or circles.</td>
</tr>
<tr id='circlemarker-color'>
<td><code><b>color</b></code></td>
<td><code>String</code>
<td><code>'#3388ff'</code></td>
<td>Stroke color</td>
</tr>
<tr id='circlemarker-weight'>
<td><code><b>weight</b></code></td>
<td><code>Number</code>
<td><code>3</code></td>
<td>Stroke width in pixels</td>
</tr>
<tr id='circlemarker-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>Stroke opacity</td>
</tr>
<tr id='circlemarker-linecap'>
<td><code><b>lineCap</b></code></td>
<td><code>String</code>
<td><code>'round'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linecap">shape to be used at the end</a> of the stroke.</td>
</tr>
<tr id='circlemarker-linejoin'>
<td><code><b>lineJoin</b></code></td>
<td><code>String</code>
<td><code>'round'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linejoin">shape to be used at the corners</a> of the stroke.</td>
</tr>
<tr id='circlemarker-dasharray'>
<td><code><b>dashArray</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>A string that defines the stroke <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dasharray">dash pattern</a>. Doesn't work on <a href="#canvas"><code>Canvas</code></a>-powered layers in <a href="https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility">some old browsers</a>.</td>
</tr>
<tr id='circlemarker-dashoffset'>
<td><code><b>dashOffset</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>A string that defines the <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dashoffset">distance into the dash pattern to start the dash</a>. Doesn't work on <a href="#canvas"><code>Canvas</code></a>-powered layers in <a href="https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility">some old browsers</a>.</td>
</tr>
<tr id='circlemarker-fill'>
<td><code><b>fill</b></code></td>
<td><code>Boolean</code>
<td><code>depends</code></td>
<td>Whether to fill the path with color. Set it to <code>false</code> to disable filling on polygons or circles.</td>
</tr>
<tr id='circlemarker-fillcolor'>
<td><code><b>fillColor</b></code></td>
<td><code>String</code>
<td><code>*</code></td>
<td>Fill color. Defaults to the value of the <a href="#path-color"><code>color</code></a> option</td>
</tr>
<tr id='circlemarker-fillopacity'>
<td><code><b>fillOpacity</b></code></td>
<td><code>Number</code>
<td><code>0.2</code></td>
<td>Fill opacity.</td>
</tr>
<tr id='circlemarker-fillrule'>
<td><code><b>fillRule</b></code></td>
<td><code>String</code>
<td><code>'evenodd'</code></td>
<td>A string that defines <a href="https://developer.mozilla.org/docs/Web/SVG/Attribute/fill-rule">how the inside of a shape</a> is determined.</td>
</tr>
<tr id='circlemarker-bubblingmouseevents'>
<td><code><b>bubblingMouseEvents</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>When <code>true</code>, a mouse event on this path will trigger the same event on the map
(unless <a href="#domevent-stoppropagation"><code>L.DomEvent.stopPropagation</code></a> is used).</td>
</tr>
<tr id='circlemarker-renderer'>
<td><code><b>renderer</b></code></td>
<td><code><a href='#renderer'>Renderer</a></code>
<td><code></code></td>
<td>Use this specific instance of <a href="#renderer"><code>Renderer</code></a> for this path. Takes
precedence over the map's <a href="#map-renderer">default renderer</a>.</td>
</tr>
<tr id='circlemarker-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>Custom class name set on an element. Only for SVG renderer.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-interactive'>
<td><code><b>interactive</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>If <code>false</code>, the layer will not emit mouse events and will act as a part of the underlying map.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='circlemarker-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Mouse events inherited from <a href='#interactive-layer'>Interactive layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-click'>
<td><code><b>click</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the layer.</td>
</tr>
<tr id='circlemarker-dblclick'>
<td><code><b>dblclick</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the layer.</td>
</tr>
<tr id='circlemarker-mousedown'>
<td><code><b>mousedown</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the layer.</td>
</tr>
<tr id='circlemarker-mouseover'>
<td><code><b>mouseover</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse enters the layer.</td>
</tr>
<tr id='circlemarker-mouseout'>
<td><code><b>mouseout</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse leaves the layer.</td>
</tr>
<tr id='circlemarker-contextmenu'>
<td><code><b>contextmenu</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user right-clicks on the layer, prevents
default browser context menu from showing if there are listeners on
this event. Also fired on mobile when the user holds a single touch
for a second (also called long press).</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='circlemarker-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='circlemarker-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='circlemarker-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='circlemarker-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-togeojson'>
<td><code><b>toGeoJSON</b>()</nobr></code></td>
<td><code>Object</code></td>
<td><p>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON"><a href="#geojson"><code>GeoJSON</code></a></a> representation of the circle marker (as a GeoJSON <a href="#point"><code>Point</code></a> Feature).</p>
</td>
</tr>
<tr id='circlemarker-setlatlng'>
<td><code><b>setLatLng</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latLng</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the position of a circle marker to a new location.</p>
</td>
</tr>
<tr id='circlemarker-getlatlng'>
<td><code><b>getLatLng</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the current geographical position of the circle marker</p>
</td>
</tr>
<tr id='circlemarker-setradius'>
<td><code><b>setRadius</b>(<nobr><Number></nobr> <i>radius</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the radius of a circle marker. Units are in pixels.</p>
</td>
</tr>
<tr id='circlemarker-getradius'>
<td><code><b>getRadius</b>()</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the current radius of the circle</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#path'>Path</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-redraw'>
<td><code><b>redraw</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.</p>
</td>
</tr>
<tr id='circlemarker-setstyle'>
<td><code><b>setStyle</b>(<nobr><<a href='#path-option'>Path options</a>></nobr> <i>style</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the appearance of a Path based on the options in the <a href="#path-option"><code>Path options</code></a> object.</p>
</td>
</tr>
<tr id='circlemarker-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the top of all path layers.</p>
</td>
</tr>
<tr id='circlemarker-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer to the bottom of all path layers.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='circlemarker-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='circlemarker-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='circlemarker-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='circlemarker-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='circlemarker-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='circlemarker-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='circlemarker-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='circlemarker-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='circlemarker-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='circlemarker-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='circlemarker-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='circlemarker-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='circlemarker-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='circlemarker-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='circlemarker-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='circlemarker-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='circlemarker-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='circlemarker-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='circlemarker-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='circlemarker-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='circlemarker-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='circlemarker-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='circlemarker-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='circlemarker-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='circlemarker-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='circlemarker-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='circlemarker-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='circlemarker-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='circlemarker-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='circlemarker-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='circlemarker-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='circlemarker-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='circlemarker-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='circlemarker-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='svg'>SVG</h2><p>Although SVG is not available on IE7 and IE8, these browsers support <a href="https://en.wikipedia.org/wiki/Vector_Markup_Language">VML</a>, and the SVG renderer will fall back to VML in this case.
VML was deprecated in 2012, which means VML functionality exists only for backwards compatibility
with old versions of Internet Explorer.</p>
<p>Allows vector layers to be displayed with <a href="https://developer.mozilla.org/docs/Web/SVG">SVG</a>.
Inherits <a href="#renderer"><code>Renderer</code></a>.
Due to <a href="http://caniuse.com/#search=svg">technical limitations</a>, SVG is not
available in all web browsers, notably Android 2.x and 3.x.
Although SVG is not available on IE7 and IE8, these browsers support
<a href="https://en.wikipedia.org/wiki/Vector_Markup_Language">VML</a>
(a now deprecated technology), and the SVG renderer will fall back to VML in
this case.</p>
<section>
<h3 id='svg-example'>Usage example</h3>
<section >
<p>Use SVG by default for all paths in the map:</p>
<pre><code class="lang-js">var map = L.map('map', {
renderer: L.svg()
});
</code></pre>
<p>Use a SVG renderer with extra padding for specific vector geometries:</p>
<pre><code class="lang-js">var map = L.map('map');
var myRenderer = L.svg({ padding: 0.5 });
var line = L.polyline( coordinates, { renderer: myRenderer } );
var circle = L.circle( center, { renderer: myRenderer } );
</code></pre>
</section>
</section><section>
<h3 id=''>Options</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#renderer'>Renderer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='svg-padding'>
<td><code><b>padding</b></code></td>
<td><code>Number</code>
<td><code>0.1</code></td>
<td>How much to extend the clip area around the map view (relative to its size)
e.g. 0.1 would be 10% of map view in each direction</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='svg-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='svg-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#renderer'>Renderer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='svg-update'>
<td><code><b>update</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the renderer updates its bounds, center and zoom, for example when
its map has moved</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='svg-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='svg-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='svg-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='svg-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='svg-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='svg-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Methods</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='svg-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='svg-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='svg-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='svg-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='svg-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='svg-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='svg-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='svg-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='svg-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='svg-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='svg-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='svg-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='svg-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='svg-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='svg-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='svg-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='svg-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='svg-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='svg-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='svg-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='svg-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='svg-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='svg-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='svg-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='svg-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='svg-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='svg-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='svg-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='svg-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='svg-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='svg-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='svg-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='svg-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='svg-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='svg-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='svg-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='svg-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='svg-function'>Functions</h3>
<section >
<div class='section-comments'>There are several static functions which can be called without instantiating L.SVG:</div>
<table><thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='svg-create'>
<td><code><b>create</b>(<nobr><String></nobr> <i>name</i>)</nobr></code></td>
<td><code>SVGElement</code></td>
<td>Returns a instance of <a href="https://developer.mozilla.org/docs/Web/API/SVGElement">SVGElement</a>,
corresponding to the class name passed. For example, using 'line' will return
an instance of <a href="https://developer.mozilla.org/docs/Web/API/SVGLineElement">SVGLineElement</a>.</td>
</tr>
<tr id='svg-pointstopath'>
<td><code><b>pointsToPath</b>(<nobr><Point[]></nobr> <i>rings</i>, <nobr><Boolean></nobr> <i>closed</i>)</nobr></code></td>
<td><code>String</code></td>
<td>Generates a SVG path string for multiple rings, with each ring turning
into "M..L..L.." instructions</td>
</tr>
</tbody></table>
</section>
</section><h2 id='canvas'>Canvas</h2><p>Allows vector layers to be displayed with <a href="https://developer.mozilla.org/docs/Web/API/Canvas_API"><code><canvas></code></a>.
Inherits <a href="#renderer"><code>Renderer</code></a>.
Due to <a href="http://caniuse.com/#search=canvas">technical limitations</a>, Canvas is not
available in all web browsers, notably IE8, and overlapping geometries might
not display properly in some edge cases.</p>
<section>
<h3 id='canvas-example'>Usage example</h3>
<section >
<p>Use Canvas by default for all paths in the map:</p>
<pre><code class="lang-js">var map = L.map('map', {
renderer: L.canvas()
});
</code></pre>
<p>Use a Canvas renderer with extra padding for specific vector geometries:</p>
<pre><code class="lang-js">var map = L.map('map');
var myRenderer = L.canvas({ padding: 0.5 });
var line = L.polyline( coordinates, { renderer: myRenderer } );
var circle = L.circle( center, { renderer: myRenderer } );
</code></pre>
</section>
</section><section>
<h3 id='canvas-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='canvas-l-canvas'>
<td><code><b>L.canvas</b>(<nobr><<a href='#renderer-option'>Renderer options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Creates a Canvas renderer with the given options.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id=''>Options</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#renderer'>Renderer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='canvas-padding'>
<td><code><b>padding</b></code></td>
<td><code>Number</code>
<td><code>0.1</code></td>
<td>How much to extend the clip area around the map view (relative to its size)
e.g. 0.1 would be 10% of map view in each direction</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='canvas-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='canvas-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#renderer'>Renderer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='canvas-update'>
<td><code><b>update</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the renderer updates its bounds, center and zoom, for example when
its map has moved</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='canvas-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='canvas-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='canvas-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='canvas-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='canvas-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='canvas-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Methods</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='canvas-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='canvas-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='canvas-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='canvas-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='canvas-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='canvas-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='canvas-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='canvas-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='canvas-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='canvas-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='canvas-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='canvas-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='canvas-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='canvas-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='canvas-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='canvas-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='canvas-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='canvas-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='canvas-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='canvas-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='canvas-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='canvas-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='canvas-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='canvas-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='canvas-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='canvas-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='canvas-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='canvas-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='canvas-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='canvas-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='canvas-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='canvas-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='canvas-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='canvas-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='canvas-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='canvas-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='canvas-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='layergroup'>LayerGroup</h2><p>Used to group several layers and handle them as one. If you add it to the map,
any layers added or removed from the group will be added/removed on the map as
well. Extends <a href="#layer"><code>Layer</code></a>.</p>
<section>
<h3 id='layergroup-example'>Usage example</h3>
<section >
<pre><code class="lang-js">L.layerGroup([marker1, marker2])
.addLayer(polyline)
.addTo(map);
</code></pre>
</section>
</section><section>
<h3 id='layergroup-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layergroup-l-layergroup'>
<td><code><b>L.layerGroup</b>(<nobr><Layer[]></nobr> <i>layers</i>)</nobr></code></td>
<td>Create a layer group, optionally given an initial set of layers.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id=''>Options</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layergroup-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='layergroup-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layergroup-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='layergroup-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layergroup-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='layergroup-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layergroup-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='layergroup-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='layergroup-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layergroup-togeojson'>
<td><code><b>toGeoJSON</b>()</nobr></code></td>
<td><code>Object</code></td>
<td><p>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON"><a href="#geojson"><code>GeoJSON</code></a></a> representation of the layer group (as a GeoJSON <code>FeatureCollection</code>, <code>GeometryCollection</code>, or <code>MultiPoint</code>).</p>
</td>
</tr>
<tr id='layergroup-addlayer'>
<td><code><b>addLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the given layer to the group.</p>
</td>
</tr>
<tr id='layergroup-removelayer'>
<td><code><b>removeLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the given layer from the group.</p>
</td>
</tr>
<tr id='layergroup-removelayer'>
<td><code><b>removeLayer</b>(<nobr><Number></nobr> <i>id</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer with the given internal ID from the group.</p>
</td>
</tr>
<tr id='layergroup-haslayer'>
<td><code><b>hasLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the given layer is currently added to the group.</p>
</td>
</tr>
<tr id='layergroup-haslayer'>
<td><code><b>hasLayer</b>(<nobr><Number></nobr> <i>id</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the given internal ID is currently added to the group.</p>
</td>
</tr>
<tr id='layergroup-clearlayers'>
<td><code><b>clearLayers</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all the layers from the group.</p>
</td>
</tr>
<tr id='layergroup-invoke'>
<td><code><b>invoke</b>(<nobr><String></nobr> <i>methodName</i>, <i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Calls <code>methodName</code> on every layer contained in this group, passing any
additional parameters. Has no effect if the layers contained do not
implement <code>methodName</code>.</p>
</td>
</tr>
<tr id='layergroup-eachlayer'>
<td><code><b>eachLayer</b>(<nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Iterates over the layers of the group, optionally specifying context of the iterator function.</p>
<pre><code class="lang-js">group.eachLayer(function (layer) {
layer.bindPopup('Hello');
});
</code></pre>
</td>
</tr>
<tr id='layergroup-getlayer'>
<td><code><b>getLayer</b>(<nobr><Number></nobr> <i>id</i>)</nobr></code></td>
<td><code><a href='#layer'>Layer</a></code></td>
<td><p>Returns the layer with the given internal ID.</p>
</td>
</tr>
<tr id='layergroup-getlayers'>
<td><code><b>getLayers</b>()</nobr></code></td>
<td><code>Layer[]</code></td>
<td><p>Returns an array of all the layers added to the group.</p>
</td>
</tr>
<tr id='layergroup-setzindex'>
<td><code><b>setZIndex</b>(<nobr><Number></nobr> <i>zIndex</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Calls <code>setZIndex</code> on every layer contained in this group, passing the z-index.</p>
</td>
</tr>
<tr id='layergroup-getlayerid'>
<td><code><b>getLayerId</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the internal ID for a layer</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layergroup-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='layergroup-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='layergroup-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='layergroup-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='layergroup-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layergroup-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='layergroup-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='layergroup-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='layergroup-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='layergroup-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='layergroup-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='layergroup-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='layergroup-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layergroup-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='layergroup-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='layergroup-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='layergroup-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='layergroup-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='layergroup-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='layergroup-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='layergroup-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layergroup-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='layergroup-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='layergroup-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='layergroup-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='layergroup-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='layergroup-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='layergroup-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='layergroup-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='layergroup-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='layergroup-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='layergroup-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='layergroup-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='layergroup-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='layergroup-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='layergroup-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='layergroup-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='featuregroup'>FeatureGroup</h2><p>Extended <a href="#layergroup"><code>LayerGroup</code></a> that makes it easier to do the same thing to all its member layers:</p>
<ul>
<li><a href="#layer-bindpopup"><code>bindPopup</code></a> binds a popup to all of the layers at once (likewise with <a href="#layer-bindtooltip"><code>bindTooltip</code></a>)</li>
<li>Events are propagated to the <a href="#featuregroup"><code>FeatureGroup</code></a>, so if the group has an event
handler, it will handle events from any of the layers. This includes mouse events
and custom events.</li>
<li>Has <code>layeradd</code> and <code>layerremove</code> events</li>
</ul>
<section>
<h3 id='featuregroup-example'>Usage example</h3>
<section >
<pre><code class="lang-js">L.featureGroup([marker1, marker2, polyline])
.bindPopup('Hello world!')
.on('click', function() { alert('Clicked on a member of the group!'); })
.addTo(map);
</code></pre>
</section>
</section><section>
<h3 id='featuregroup-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='featuregroup-l-featuregroup'>
<td><code><b>L.featureGroup</b>(<nobr><Layer[]></nobr> <i>layers</i>)</nobr></code></td>
<td>Create a feature group, optionally given an initial set of layers.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id=''>Options</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='featuregroup-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='featuregroup-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='featuregroup-event'>Events</h3>
<section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='featuregroup-layeradd'>
<td><code><b>layeradd</b>
<td><code><a href='#layerevent'>LayerEvent</a></code></td>
<td>Fired when a layer is added to this <a href="#featuregroup"><code>FeatureGroup</code></a></td>
</tr>
<tr id='featuregroup-layerremove'>
<td><code><b>layerremove</b>
<td><code><a href='#layerevent'>LayerEvent</a></code></td>
<td>Fired when a layer is removed from this <a href="#featuregroup"><code>FeatureGroup</code></a></td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='featuregroup-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='featuregroup-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='featuregroup-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='featuregroup-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='featuregroup-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='featuregroup-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='featuregroup-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='featuregroup-setstyle'>
<td><code><b>setStyle</b>(<nobr><<a href='#path-option'>Path options</a>></nobr> <i>style</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the given path options to each layer of the group that has a <code>setStyle</code> method.</p>
</td>
</tr>
<tr id='featuregroup-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer group to the top of all other layers</p>
</td>
</tr>
<tr id='featuregroup-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer group to the top of all other layers</p>
</td>
</tr>
<tr id='featuregroup-getbounds'>
<td><code><b>getBounds</b>()</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Returns the LatLngBounds of the Feature Group (created from bounds and coordinates of its children).</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layergroup'>LayerGroup</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='featuregroup-togeojson'>
<td><code><b>toGeoJSON</b>()</nobr></code></td>
<td><code>Object</code></td>
<td><p>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON"><a href="#geojson"><code>GeoJSON</code></a></a> representation of the layer group (as a GeoJSON <code>FeatureCollection</code>, <code>GeometryCollection</code>, or <code>MultiPoint</code>).</p>
</td>
</tr>
<tr id='featuregroup-addlayer'>
<td><code><b>addLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the given layer to the group.</p>
</td>
</tr>
<tr id='featuregroup-removelayer'>
<td><code><b>removeLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the given layer from the group.</p>
</td>
</tr>
<tr id='featuregroup-removelayer'>
<td><code><b>removeLayer</b>(<nobr><Number></nobr> <i>id</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer with the given internal ID from the group.</p>
</td>
</tr>
<tr id='featuregroup-haslayer'>
<td><code><b>hasLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the given layer is currently added to the group.</p>
</td>
</tr>
<tr id='featuregroup-haslayer'>
<td><code><b>hasLayer</b>(<nobr><Number></nobr> <i>id</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the given internal ID is currently added to the group.</p>
</td>
</tr>
<tr id='featuregroup-clearlayers'>
<td><code><b>clearLayers</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all the layers from the group.</p>
</td>
</tr>
<tr id='featuregroup-invoke'>
<td><code><b>invoke</b>(<nobr><String></nobr> <i>methodName</i>, <i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Calls <code>methodName</code> on every layer contained in this group, passing any
additional parameters. Has no effect if the layers contained do not
implement <code>methodName</code>.</p>
</td>
</tr>
<tr id='featuregroup-eachlayer'>
<td><code><b>eachLayer</b>(<nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Iterates over the layers of the group, optionally specifying context of the iterator function.</p>
<pre><code class="lang-js">group.eachLayer(function (layer) {
layer.bindPopup('Hello');
});
</code></pre>
</td>
</tr>
<tr id='featuregroup-getlayer'>
<td><code><b>getLayer</b>(<nobr><Number></nobr> <i>id</i>)</nobr></code></td>
<td><code><a href='#layer'>Layer</a></code></td>
<td><p>Returns the layer with the given internal ID.</p>
</td>
</tr>
<tr id='featuregroup-getlayers'>
<td><code><b>getLayers</b>()</nobr></code></td>
<td><code>Layer[]</code></td>
<td><p>Returns an array of all the layers added to the group.</p>
</td>
</tr>
<tr id='featuregroup-setzindex'>
<td><code><b>setZIndex</b>(<nobr><Number></nobr> <i>zIndex</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Calls <code>setZIndex</code> on every layer contained in this group, passing the z-index.</p>
</td>
</tr>
<tr id='featuregroup-getlayerid'>
<td><code><b>getLayerId</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the internal ID for a layer</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='featuregroup-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='featuregroup-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='featuregroup-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='featuregroup-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='featuregroup-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='featuregroup-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='featuregroup-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='featuregroup-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='featuregroup-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='featuregroup-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='featuregroup-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='featuregroup-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='featuregroup-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='featuregroup-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='featuregroup-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='featuregroup-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='featuregroup-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='featuregroup-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='featuregroup-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='featuregroup-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='featuregroup-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='featuregroup-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='featuregroup-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='featuregroup-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='featuregroup-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='featuregroup-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='featuregroup-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='featuregroup-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='featuregroup-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='featuregroup-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='featuregroup-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='featuregroup-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='featuregroup-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='featuregroup-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='featuregroup-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='featuregroup-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='featuregroup-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='geojson'>GeoJSON</h2><p>Represents a GeoJSON object or an array of GeoJSON objects. Allows you to parse
GeoJSON data and display it on the map. Extends <a href="#featuregroup"><code>FeatureGroup</code></a>.</p>
<section>
<h3 id='geojson-example'>Usage example</h3>
<section >
<pre><code class="lang-js">L.geoJSON(data, {
style: function (feature) {
return {color: feature.properties.color};
}
}).bindPopup(function (layer) {
return layer.feature.properties.description;
}).addTo(map);
</code></pre>
</section>
</section><section>
<h3 id='geojson-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-l-geojson'>
<td><code><b>L.geoJSON</b>(<nobr><Object></nobr> <i>geojson?</i>, <nobr><<a href='#geojson-option'>GeoJSON options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Creates a GeoJSON layer. Optionally accepts an object in
<a href="http://geojson.org/geojson-spec.html">GeoJSON format</a> to display on the map
(you can alternatively add it later with <code>addData</code> method) and an <code>options</code> object.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='geojson-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-pointtolayer'>
<td><code><b>pointToLayer</b></code></td>
<td><code>Function</code>
<td><code>*</code></td>
<td>A <code>Function</code> defining how GeoJSON points spawn Leaflet layers. It is internally
called when data is added, passing the GeoJSON point feature and its <a href="#latlng"><code>LatLng</code></a>.
The default is to spawn a default <a href="#marker"><code>Marker</code></a>:
<pre><code class="lang-js">function(geoJsonPoint, latlng) {
return L.marker(latlng);
}
</code></pre></td>
</tr>
<tr id='geojson-style'>
<td><code><b>style</b></code></td>
<td><code>Function</code>
<td><code>*</code></td>
<td>A <code>Function</code> defining the <a href="#path-option"><code>Path options</code></a> for styling GeoJSON lines and polygons,
called internally when data is added.
The default value is to not override any defaults:
<pre><code class="lang-js">function (geoJsonFeature) {
return {}
}
</code></pre></td>
</tr>
<tr id='geojson-oneachfeature'>
<td><code><b>onEachFeature</b></code></td>
<td><code>Function</code>
<td><code>*</code></td>
<td>A <code>Function</code> that will be called once for each created <code>Feature</code>, after it has
been created and styled. Useful for attaching events and popups to features.
The default is to do nothing with the newly created layers:
<pre><code class="lang-js">function (feature, layer) {}
</code></pre></td>
</tr>
<tr id='geojson-filter'>
<td><code><b>filter</b></code></td>
<td><code>Function</code>
<td><code>*</code></td>
<td>A <code>Function</code> that will be used to decide whether to include a feature or not.
The default is to include all features:
<pre><code class="lang-js">function (geoJsonFeature) {
return true;
}
</code></pre>
<p>Note: dynamically changing the <code>filter</code> option will have effect only on newly
added data. It will <em>not</em> re-evaluate already included features.</p></td>
</tr>
<tr id='geojson-coordstolatlng'>
<td><code><b>coordsToLatLng</b></code></td>
<td><code>Function</code>
<td><code>*</code></td>
<td>A <code>Function</code> that will be used for converting GeoJSON coordinates to <a href="#latlng"><code>LatLng</code></a>s.
The default is the <code>coordsToLatLng</code> static method.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='geojson-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#featuregroup'>FeatureGroup</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-layeradd'>
<td><code><b>layeradd</b>
<td><code><a href='#layerevent'>LayerEvent</a></code></td>
<td>Fired when a layer is added to this <a href="#featuregroup"><code>FeatureGroup</code></a></td>
</tr>
<tr id='geojson-layerremove'>
<td><code><b>layerremove</b>
<td><code><a href='#layerevent'>LayerEvent</a></code></td>
<td>Fired when a layer is removed from this <a href="#featuregroup"><code>FeatureGroup</code></a></td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='geojson-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='geojson-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='geojson-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='geojson-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-adddata'>
<td><code><b>addData</b>(<i>data</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a GeoJSON object to the layer.</p>
</td>
</tr>
<tr id='geojson-resetstyle'>
<td><code><b>resetStyle</b>(<i>layer</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Resets the given vector layer's style to the original GeoJSON style, useful for resetting style after hover events.</p>
</td>
</tr>
<tr id='geojson-setstyle'>
<td><code><b>setStyle</b>(<i>style</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes styles of GeoJSON vector layers with the given style function.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#featuregroup'>FeatureGroup</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer group to the top of all other layers</p>
</td>
</tr>
<tr id='geojson-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the layer group to the top of all other layers</p>
</td>
</tr>
<tr id='geojson-getbounds'>
<td><code><b>getBounds</b>()</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Returns the LatLngBounds of the Feature Group (created from bounds and coordinates of its children).</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layergroup'>LayerGroup</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-togeojson'>
<td><code><b>toGeoJSON</b>()</nobr></code></td>
<td><code>Object</code></td>
<td><p>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON"><a href="#geojson"><code>GeoJSON</code></a></a> representation of the layer group (as a GeoJSON <code>FeatureCollection</code>, <code>GeometryCollection</code>, or <code>MultiPoint</code>).</p>
</td>
</tr>
<tr id='geojson-addlayer'>
<td><code><b>addLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the given layer to the group.</p>
</td>
</tr>
<tr id='geojson-removelayer'>
<td><code><b>removeLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the given layer from the group.</p>
</td>
</tr>
<tr id='geojson-removelayer'>
<td><code><b>removeLayer</b>(<nobr><Number></nobr> <i>id</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer with the given internal ID from the group.</p>
</td>
</tr>
<tr id='geojson-haslayer'>
<td><code><b>hasLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the given layer is currently added to the group.</p>
</td>
</tr>
<tr id='geojson-haslayer'>
<td><code><b>hasLayer</b>(<nobr><Number></nobr> <i>id</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the given internal ID is currently added to the group.</p>
</td>
</tr>
<tr id='geojson-clearlayers'>
<td><code><b>clearLayers</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all the layers from the group.</p>
</td>
</tr>
<tr id='geojson-invoke'>
<td><code><b>invoke</b>(<nobr><String></nobr> <i>methodName</i>, <i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Calls <code>methodName</code> on every layer contained in this group, passing any
additional parameters. Has no effect if the layers contained do not
implement <code>methodName</code>.</p>
</td>
</tr>
<tr id='geojson-eachlayer'>
<td><code><b>eachLayer</b>(<nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Iterates over the layers of the group, optionally specifying context of the iterator function.</p>
<pre><code class="lang-js">group.eachLayer(function (layer) {
layer.bindPopup('Hello');
});
</code></pre>
</td>
</tr>
<tr id='geojson-getlayer'>
<td><code><b>getLayer</b>(<nobr><Number></nobr> <i>id</i>)</nobr></code></td>
<td><code><a href='#layer'>Layer</a></code></td>
<td><p>Returns the layer with the given internal ID.</p>
</td>
</tr>
<tr id='geojson-getlayers'>
<td><code><b>getLayers</b>()</nobr></code></td>
<td><code>Layer[]</code></td>
<td><p>Returns an array of all the layers added to the group.</p>
</td>
</tr>
<tr id='geojson-setzindex'>
<td><code><b>setZIndex</b>(<nobr><Number></nobr> <i>zIndex</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Calls <code>setZIndex</code> on every layer contained in this group, passing the z-index.</p>
</td>
</tr>
<tr id='geojson-getlayerid'>
<td><code><b>getLayerId</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the internal ID for a layer</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='geojson-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='geojson-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='geojson-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='geojson-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='geojson-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='geojson-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='geojson-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='geojson-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='geojson-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='geojson-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='geojson-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='geojson-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='geojson-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='geojson-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='geojson-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='geojson-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='geojson-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='geojson-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='geojson-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='geojson-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='geojson-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='geojson-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='geojson-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='geojson-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='geojson-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='geojson-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='geojson-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='geojson-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='geojson-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='geojson-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='geojson-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='geojson-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='geojson-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='geojson-function'>Functions</h3>
<section >
<div class='section-comments'>There are several static functions which can be called without instantiating L.GeoJSON:</div>
<table><thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojson-geometrytolayer'>
<td><code><b>geometryToLayer</b>(<nobr><Object></nobr> <i>featureData</i>, <nobr><<a href='#geojson-option'>GeoJSON options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code><a href='#layer'>Layer</a></code></td>
<td>Creates a <a href="#layer"><code>Layer</code></a> from a given GeoJSON feature. Can use a custom
<a href="#geojson-pointtolayer"><code>pointToLayer</code></a> and/or <a href="#geojson-coordstolatlng"><code>coordsToLatLng</code></a>
functions if provided as options.</td>
</tr>
<tr id='geojson-coordstolatlng'>
<td><code><b>coordsToLatLng</b>(<nobr><Array></nobr> <i>coords</i>)</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td>Creates a <a href="#latlng"><code>LatLng</code></a> object from an array of 2 numbers (longitude, latitude)
or 3 numbers (longitude, latitude, altitude) used in GeoJSON for points.</td>
</tr>
<tr id='geojson-coordstolatlngs'>
<td><code><b>coordsToLatLngs</b>(<nobr><Array></nobr> <i>coords</i>, <nobr><Number></nobr> <i>levelsDeep?</i>, <nobr><Function></nobr> <i>coordsToLatLng?</i>)</nobr></code></td>
<td><code>Array</code></td>
<td>Creates a multidimensional array of <a href="#latlng"><code>LatLng</code></a>s from a GeoJSON coordinates array.
<code>levelsDeep</code> specifies the nesting level (0 is for an array of points, 1 for an array of arrays of points, etc., 0 by default).
Can use a custom <a href="#geojson-coordstolatlng"><code>coordsToLatLng</code></a> function.</td>
</tr>
<tr id='geojson-latlngtocoords'>
<td><code><b>latLngToCoords</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><Number></nobr> <i>precision?</i>)</nobr></code></td>
<td><code>Array</code></td>
<td>Reverse of <a href="#geojson-coordstolatlng"><code>coordsToLatLng</code></a></td>
</tr>
<tr id='geojson-latlngstocoords'>
<td><code><b>latLngsToCoords</b>(<nobr><Array></nobr> <i>latlngs</i>, <nobr><Number></nobr> <i>levelsDeep?</i>, <nobr><Boolean></nobr> <i>closed?</i>)</nobr></code></td>
<td><code>Array</code></td>
<td>Reverse of <a href="#geojson-coordstolatlngs"><code>coordsToLatLngs</code></a>
<code>closed</code> determines whether the first point should be appended to the end of the array to close the feature, only used when <code>levelsDeep</code> is 0. False by default.</td>
</tr>
<tr id='geojson-asfeature'>
<td><code><b>asFeature</b>(<nobr><Object></nobr> <i>geojson</i>)</nobr></code></td>
<td><code>Object</code></td>
<td>Normalize GeoJSON geometries/features into GeoJSON features.</td>
</tr>
</tbody></table>
</section>
</section><h2 id='gridlayer'>GridLayer</h2><p>Generic class for handling a tiled grid of HTML elements. This is the base class for all tile layers and replaces <code>TileLayer.Canvas</code>.
GridLayer can be extended to create a tiled grid of HTML elements like <code><canvas></code>, <code><img></code> or <code><div></code>. GridLayer will handle creating and animating these DOM elements for you.</p>
<section>
<h3 id='gridlayer-example'>Usage example</h3>
<section >
<h4 id='gridlayer-synchronous-usage'>Synchronous usage</h4>
<p>To create a custom layer, extend GridLayer and implement the <code>createTile()</code> method, which will be passed a <a href="#point"><code>Point</code></a> object with the <code>x</code>, <code>y</code>, and <code>z</code> (zoom level) coordinates to draw your tile.</p>
<pre><code class="lang-js">var CanvasLayer = L.GridLayer.extend({
createTile: function(coords){
// create a <canvas> element for drawing
var tile = L.DomUtil.create('canvas', 'leaflet-tile');
// setup tile width and height according to the options
var size = this.getTileSize();
tile.width = size.x;
tile.height = size.y;
// get a canvas context and draw something on it using coords.x, coords.y and coords.z
var ctx = tile.getContext('2d');
// return the tile so it can be rendered on screen
return tile;
}
});
</code></pre>
</section><section >
<h4 id='gridlayer-asynchronous-usage'>Asynchronous usage</h4>
<p>Tile creation can also be asynchronous, this is useful when using a third-party drawing library. Once the tile is finished drawing it can be passed to the <code>done()</code> callback.</p>
<pre><code class="lang-js">var CanvasLayer = L.GridLayer.extend({
createTile: function(coords, done){
var error;
// create a <canvas> element for drawing
var tile = L.DomUtil.create('canvas', 'leaflet-tile');
// setup tile width and height according to the options
var size = this.getTileSize();
tile.width = size.x;
tile.height = size.y;
// draw something asynchronously and pass the tile to the done() callback
setTimeout(function() {
done(error, tile);
}, 1000);
return tile;
}
});
</code></pre>
</section>
</section><section>
<h3 id='gridlayer-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-l-gridlayer'>
<td><code><b>L.gridLayer</b>(<nobr><<a href='#gridlayer-option'>GridLayer options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Creates a new instance of GridLayer with the supplied options.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='gridlayer-option'>Options</h3>
<section >
<div class='section-comments'></div>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-tilesize'>
<td><code><b>tileSize</b></code></td>
<td><code>Number|Point</code>
<td><code>256</code></td>
<td>Width and height of tiles in the grid. Use a number if width and height are equal, or <code>L.point(width, height)</code> otherwise.</td>
</tr>
<tr id='gridlayer-opacity'>
<td><code><b>opacity</b></code></td>
<td><code>Number</code>
<td><code>1.0</code></td>
<td>Opacity of the tiles. Can be used in the <code>createTile()</code> function.</td>
</tr>
<tr id='gridlayer-updatewhenidle'>
<td><code><b>updateWhenIdle</b></code></td>
<td><code>Boolean</code>
<td><code>depends</code></td>
<td>If <code>false</code>, new tiles are loaded during panning, otherwise only after it (for better performance). <code>true</code> by default on mobile browsers, otherwise <code>false</code>.</td>
</tr>
<tr id='gridlayer-updatewhenzooming'>
<td><code><b>updateWhenZooming</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>By default, a smooth zoom animation (during a <a href="#map-touchzoom">touch zoom</a> or a <a href="#map-flyto"><code>flyTo()</code></a>) will update grid layers every integer zoom level. Setting this option to <code>false</code> will update the grid layer only when the smooth animation ends.</td>
</tr>
<tr id='gridlayer-updateinterval'>
<td><code><b>updateInterval</b></code></td>
<td><code>Number</code>
<td><code>200</code></td>
<td>Tiles will not update more than once every <code>updateInterval</code> milliseconds when panning.</td>
</tr>
<tr id='gridlayer-zindex'>
<td><code><b>zIndex</b></code></td>
<td><code>Number</code>
<td><code>1</code></td>
<td>The explicit zIndex of the tile layer.</td>
</tr>
<tr id='gridlayer-bounds'>
<td><code><b>bounds</b></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code>
<td><code>undefined</code></td>
<td>If set, tiles will only be loaded inside the set <a href="#latlngbounds"><code>LatLngBounds</code></a>.</td>
</tr>
<tr id='gridlayer-minzoom'>
<td><code><b>minZoom</b></code></td>
<td><code>Number</code>
<td><code>0</code></td>
<td>The minimum zoom level down to which this layer will be displayed (inclusive).</td>
</tr>
<tr id='gridlayer-maxzoom'>
<td><code><b>maxZoom</b></code></td>
<td><code>Number</code>
<td><code>undefined</code></td>
<td>The maximum zoom level up to which this layer will be displayed (inclusive).</td>
</tr>
<tr id='gridlayer-maxnativezoom'>
<td><code><b>maxNativeZoom</b></code></td>
<td><code>Number</code>
<td><code>undefined</code></td>
<td>Maximum zoom number the tile source has available. If it is specified,
the tiles on all zoom levels higher than <code>maxNativeZoom</code> will be loaded
from <code>maxNativeZoom</code> level and auto-scaled.</td>
</tr>
<tr id='gridlayer-minnativezoom'>
<td><code><b>minNativeZoom</b></code></td>
<td><code>Number</code>
<td><code>undefined</code></td>
<td>Minimum zoom number the tile source has available. If it is specified,
the tiles on all zoom levels lower than <code>minNativeZoom</code> will be loaded
from <code>minNativeZoom</code> level and auto-scaled.</td>
</tr>
<tr id='gridlayer-nowrap'>
<td><code><b>noWrap</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>Whether the layer is wrapped around the antimeridian. If <code>true</code>, the
GridLayer will only be displayed once at low zoom levels. Has no
effect when the <a href="#map-crs">map CRS</a> doesn't wrap around. Can be used
in combination with <a href="#gridlayer-bounds"><a href="#bounds"><code>bounds</code></a></a> to prevent requesting
tiles outside the CRS limits.</td>
</tr>
<tr id='gridlayer-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'tilePane'</code></td>
<td><code>Map pane</code> where the grid layer will be added.</td>
</tr>
<tr id='gridlayer-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>A custom class name to assign to the tile layer. Empty by default.</td>
</tr>
<tr id='gridlayer-keepbuffer'>
<td><code><b>keepBuffer</b></code></td>
<td><code>Number</code>
<td><code>2</code></td>
<td>When panning the map, keep this many rows and columns of tiles before unloading them.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='gridlayer-event'>Events</h3>
<section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-loading'>
<td><code><b>loading</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the grid layer starts loading tiles.</td>
</tr>
<tr id='gridlayer-tileunload'>
<td><code><b>tileunload</b>
<td><code><a href='#tileevent'>TileEvent</a></code></td>
<td>Fired when a tile is removed (e.g. when a tile goes off the screen).</td>
</tr>
<tr id='gridlayer-tileloadstart'>
<td><code><b>tileloadstart</b>
<td><code><a href='#tileevent'>TileEvent</a></code></td>
<td>Fired when a tile is requested and starts loading.</td>
</tr>
<tr id='gridlayer-tileerror'>
<td><code><b>tileerror</b>
<td><code><a href='#tileerrorevent'>TileErrorEvent</a></code></td>
<td>Fired when there is an error loading a tile.</td>
</tr>
<tr id='gridlayer-tileload'>
<td><code><b>tileload</b>
<td><code><a href='#tileevent'>TileEvent</a></code></td>
<td>Fired when a tile loads.</td>
</tr>
<tr id='gridlayer-load'>
<td><code><b>load</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the grid layer loaded all visible tiles.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='gridlayer-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='gridlayer-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='gridlayer-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='gridlayer-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-bringtofront'>
<td><code><b>bringToFront</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the tile layer to the top of all tile layers.</p>
</td>
</tr>
<tr id='gridlayer-bringtoback'>
<td><code><b>bringToBack</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Brings the tile layer to the bottom of all tile layers.</p>
</td>
</tr>
<tr id='gridlayer-getcontainer'>
<td><code><b>getContainer</b>()</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the HTML element that contains the tiles for this layer.</p>
</td>
</tr>
<tr id='gridlayer-setopacity'>
<td><code><b>setOpacity</b>(<nobr><Number></nobr> <i>opacity</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the <a href="#gridlayer-opacity">opacity</a> of the grid layer.</p>
</td>
</tr>
<tr id='gridlayer-setzindex'>
<td><code><b>setZIndex</b>(<nobr><Number></nobr> <i>zIndex</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Changes the <a href="#gridlayer-zindex">zIndex</a> of the grid layer.</p>
</td>
</tr>
<tr id='gridlayer-isloading'>
<td><code><b>isLoading</b>()</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if any tile in the grid layer has not finished loading.</p>
</td>
</tr>
<tr id='gridlayer-redraw'>
<td><code><b>redraw</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Causes the layer to clear all the tiles and request them again.</p>
</td>
</tr>
<tr id='gridlayer-gettilesize'>
<td><code><b>getTileSize</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Normalizes the <a href="#gridlayer-tilesize">tileSize option</a> into a point. Used by the <code>createTile()</code> method.</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='gridlayer-extension-methods'>Extension methods</h4>
<div class='section-comments'>Layers extending <a href="#gridlayer"><code>GridLayer</code></a> shall reimplement the following method.</div>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-createtile'>
<td><code><b>createTile</b>(<nobr><Object></nobr> <i>coords</i>, <nobr><Function></nobr> <i>done?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Called only internally, must be overriden by classes extending <a href="#gridlayer"><code>GridLayer</code></a>.
Returns the <code>HTMLElement</code> corresponding to the given <code>coords</code>. If the <code>done</code> callback
is specified, it must be called when the tile has finished loading and drawing.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='gridlayer-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='gridlayer-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='gridlayer-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='gridlayer-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='gridlayer-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='gridlayer-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='gridlayer-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='gridlayer-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='gridlayer-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='gridlayer-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='gridlayer-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='gridlayer-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='gridlayer-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='gridlayer-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='gridlayer-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='gridlayer-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='gridlayer-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='gridlayer-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='gridlayer-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='gridlayer-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='gridlayer-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='gridlayer-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='gridlayer-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='gridlayer-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='gridlayer-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='gridlayer-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='gridlayer-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='gridlayer-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='gridlayer-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='gridlayer-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='gridlayer-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='gridlayer-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='gridlayer-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='gridlayer-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='latlng'>LatLng</h2><p>Represents a geographical point with a certain latitude and longitude.</p>
<section>
<h3 id='latlng-example'>Usage example</h3>
<section >
<pre><code>var latlng = L.latLng(50.5, 30.5);
</code></pre><p>All Leaflet methods that accept LatLng objects also accept them in a simple Array form and simple object form (unless noted otherwise), so these lines are equivalent:</p>
<pre><code>map.panTo([50, 30]);
map.panTo({lon: 30, lat: 50});
map.panTo({lat: 50, lng: 30});
map.panTo(L.latLng(50, 30));
</code></pre>
</section>
</section><section>
<h3 id='latlng-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='latlng-l-latlng'>
<td><code><b>L.latLng</b>(<nobr><Number></nobr> <i>latitude</i>, <nobr><Number></nobr> <i>longitude</i>, <nobr><Number></nobr> <i>altitude?</i>)</nobr></code></td>
<td>Creates an object representing a geographical point with the given latitude and longitude (and optionally altitude).</td>
</tr>
<tr id='latlng-l-latlng'>
<td><code><b>L.latLng</b>(<nobr><Array></nobr> <i>coords</i>)</nobr></code></td>
<td>Expects an array of the form <code>[Number, Number]</code> or <code>[Number, Number, Number]</code> instead.</td>
</tr>
<tr id='latlng-l-latlng'>
<td><code><b>L.latLng</b>(<nobr><Object></nobr> <i>coords</i>)</nobr></code></td>
<td>Expects an plain object of the form <code>{lat: Number, lng: Number}</code> or <code>{lat: Number, lng: Number, alt: Number}</code> instead.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='latlng-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='latlng-equals'>
<td><code><b>equals</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>otherLatLng</i>, <nobr><Number></nobr> <i>maxMargin?</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the given <a href="#latlng"><code>LatLng</code></a> point is at the same position (within a small margin of error). The margin of error can be overriden by setting <code>maxMargin</code> to a small number.</p>
</td>
</tr>
<tr id='latlng-tostring'>
<td><code><b>toString</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Returns a string representation of the point (for debugging purposes).</p>
</td>
</tr>
<tr id='latlng-distanceto'>
<td><code><b>distanceTo</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>otherLatLng</i>)</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the distance (in meters) to the given <a href="#latlng"><code>LatLng</code></a> calculated using the <a href="http://en.wikipedia.org/wiki/Haversine_formula">Haversine formula</a>.</p>
</td>
</tr>
<tr id='latlng-wrap'>
<td><code><b>wrap</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns a new <a href="#latlng"><code>LatLng</code></a> object with the longitude wrapped so it's always between -180 and +180 degrees.</p>
</td>
</tr>
<tr id='latlng-tobounds'>
<td><code><b>toBounds</b>(<nobr><Number></nobr> <i>sizeInMeters</i>)</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Returns a new <a href="#latlngbounds"><code>LatLngBounds</code></a> object in which each boundary is <code>sizeInMeters/2</code> meters apart from the <a href="#latlng"><code>LatLng</code></a>.</p>
</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='latlng-property'>Properties</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='latlng-lat'>
<td><code><b>lat</b>
<td><code>Number</code></td>
<td>Latitude in degrees</td>
</tr>
<tr id='latlng-lng'>
<td><code><b>lng</b>
<td><code>Number</code></td>
<td>Longitude in degrees</td>
</tr>
<tr id='latlng-alt'>
<td><code><b>alt</b>
<td><code>Number</code></td>
<td>Altitude in meters (optional)</td>
</tr>
</tbody></table>
</section>
</section><h2 id='latlngbounds'>LatLngBounds</h2><p>Represents a rectangular geographical area on a map.</p>
<section>
<h3 id='latlngbounds-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var corner1 = L.latLng(40.712, -74.227),
corner2 = L.latLng(40.774, -74.125),
bounds = L.latLngBounds(corner1, corner2);
</code></pre>
<p>All Leaflet methods that accept LatLngBounds objects also accept them in a simple Array form (unless noted otherwise), so the bounds example above can be passed like this:</p>
<pre><code class="lang-js">map.fitBounds([
[40.712, -74.227],
[40.774, -74.125]
]);
</code></pre>
<p>Caution: if the area crosses the antimeridian (often confused with the International Date Line), you must specify corners <em>outside</em> the [-180, 180] degrees longitude range.</p>
</section>
</section><section>
<h3 id='latlngbounds-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='latlngbounds-l-latlngbounds'>
<td><code><b>L.latLngBounds</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>corner1</i>, <nobr><<a href='#latlng'>LatLng</a>></nobr> <i>corner2</i>)</nobr></code></td>
<td>Creates a <a href="#latlngbounds"><code>LatLngBounds</code></a> object by defining two diagonally opposite corners of the rectangle.</td>
</tr>
<tr id='latlngbounds-l-latlngbounds'>
<td><code><b>L.latLngBounds</b>(<nobr><LatLng[]></nobr> <i>latlngs</i>)</nobr></code></td>
<td>Creates a <a href="#latlngbounds"><code>LatLngBounds</code></a> object defined by the geographical points it contains. Very useful for zooming the map to fit a particular set of locations with <a href="#map-fitbounds"><code>fitBounds</code></a>.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='latlngbounds-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='latlngbounds-extend'>
<td><code><b>extend</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Extend the bounds to contain the given point</p>
</td>
</tr>
<tr id='latlngbounds-extend'>
<td><code><b>extend</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>otherBounds</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Extend the bounds to contain the given bounds</p>
</td>
</tr>
<tr id='latlngbounds-pad'>
<td><code><b>pad</b>(<nobr><Number></nobr> <i>bufferRatio</i>)</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Returns bigger bounds created by extending the current bounds by a given percentage in each direction.</p>
</td>
</tr>
<tr id='latlngbounds-getcenter'>
<td><code><b>getCenter</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the center point of the bounds.</p>
</td>
</tr>
<tr id='latlngbounds-getsouthwest'>
<td><code><b>getSouthWest</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the south-west point of the bounds.</p>
</td>
</tr>
<tr id='latlngbounds-getnortheast'>
<td><code><b>getNorthEast</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the north-east point of the bounds.</p>
</td>
</tr>
<tr id='latlngbounds-getnorthwest'>
<td><code><b>getNorthWest</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the north-west point of the bounds.</p>
</td>
</tr>
<tr id='latlngbounds-getsoutheast'>
<td><code><b>getSouthEast</b>()</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns the south-east point of the bounds.</p>
</td>
</tr>
<tr id='latlngbounds-getwest'>
<td><code><b>getWest</b>()</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the west longitude of the bounds</p>
</td>
</tr>
<tr id='latlngbounds-getsouth'>
<td><code><b>getSouth</b>()</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the south latitude of the bounds</p>
</td>
</tr>
<tr id='latlngbounds-geteast'>
<td><code><b>getEast</b>()</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the east longitude of the bounds</p>
</td>
</tr>
<tr id='latlngbounds-getnorth'>
<td><code><b>getNorth</b>()</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the north latitude of the bounds</p>
</td>
</tr>
<tr id='latlngbounds-contains'>
<td><code><b>contains</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>otherBounds</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the rectangle contains the given one.</p>
</td>
</tr>
<tr id='latlngbounds-contains'>
<td><code><b>contains</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the rectangle contains the given point.</p>
</td>
</tr>
<tr id='latlngbounds-intersects'>
<td><code><b>intersects</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>otherBounds</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the rectangle intersects the given bounds. Two bounds intersect if they have at least one point in common.</p>
</td>
</tr>
<tr id='latlngbounds-overlaps'>
<td><code><b>overlaps</b>(<nobr><<a href='#bounds'>Bounds</a>></nobr> <i>otherBounds</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the rectangle overlaps the given bounds. Two bounds overlap if their intersection is an area.</p>
</td>
</tr>
<tr id='latlngbounds-tobboxstring'>
<td><code><b>toBBoxString</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Returns a string with bounding box coordinates in a 'southwest_lng,southwest_lat,northeast_lng,northeast_lat' format. Useful for sending requests to web services that return geo data.</p>
</td>
</tr>
<tr id='latlngbounds-equals'>
<td><code><b>equals</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>otherBounds</i>, <nobr><Number></nobr> <i>maxMargin?</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the rectangle is equivalent (within a small margin of error) to the given bounds. The margin of error can be overriden by setting <code>maxMargin</code> to a small number.</p>
</td>
</tr>
<tr id='latlngbounds-isvalid'>
<td><code><b>isValid</b>()</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the bounds are properly initialized.</p>
</td>
</tr>
</tbody></table>
</section>
</section><h2 id='point'>Point</h2><p>Represents a point with <code>x</code> and <code>y</code> coordinates in pixels.</p>
<section>
<h3 id='point-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var point = L.point(200, 300);
</code></pre>
<p>All Leaflet methods and options that accept <a href="#point"><code>Point</code></a> objects also accept them in a simple Array form (unless noted otherwise), so these lines are equivalent:</p>
<pre><code class="lang-js">map.panBy([200, 300]);
map.panBy(L.point(200, 300));
</code></pre>
</section>
</section><section>
<h3 id='point-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='point-l-point'>
<td><code><b>L.point</b>(<nobr><Number></nobr> <i>x</i>, <nobr><Number></nobr> <i>y</i>, <nobr><Boolean></nobr> <i>round?</i>)</nobr></code></td>
<td>Creates a Point object with the given <code>x</code> and <code>y</code> coordinates. If optional <code>round</code> is set to true, rounds the <code>x</code> and <code>y</code> values.</td>
</tr>
<tr id='point-l-point'>
<td><code><b>L.point</b>(<nobr><Number[]></nobr> <i>coords</i>)</nobr></code></td>
<td>Expects an array of the form <code>[x, y]</code> instead.</td>
</tr>
<tr id='point-l-point'>
<td><code><b>L.point</b>(<nobr><Object></nobr> <i>coords</i>)</nobr></code></td>
<td>Expects a plain object of the form <code>{x: Number, y: Number}</code> instead.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='point-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='point-clone'>
<td><code><b>clone</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns a copy of the current point.</p>
</td>
</tr>
<tr id='point-add'>
<td><code><b>add</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>otherPoint</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the result of addition of the current and the given points.</p>
</td>
</tr>
<tr id='point-subtract'>
<td><code><b>subtract</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>otherPoint</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the result of subtraction of the given point from the current.</p>
</td>
</tr>
<tr id='point-divideby'>
<td><code><b>divideBy</b>(<nobr><Number></nobr> <i>num</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the result of division of the current point by the given number.</p>
</td>
</tr>
<tr id='point-multiplyby'>
<td><code><b>multiplyBy</b>(<nobr><Number></nobr> <i>num</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the result of multiplication of the current point by the given number.</p>
</td>
</tr>
<tr id='point-scaleby'>
<td><code><b>scaleBy</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>scale</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Multiply each coordinate of the current point by each coordinate of
<code>scale</code>. In linear algebra terms, multiply the point by the
<a href="https://en.wikipedia.org/wiki/Scaling_%28geometry%29#Matrix_representation">scaling matrix</a>
defined by <code>scale</code>.</p>
</td>
</tr>
<tr id='point-unscaleby'>
<td><code><b>unscaleBy</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>scale</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Inverse of <code>scaleBy</code>. Divide each coordinate of the current point by
each coordinate of <code>scale</code>.</p>
</td>
</tr>
<tr id='point-round'>
<td><code><b>round</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns a copy of the current point with rounded coordinates.</p>
</td>
</tr>
<tr id='point-floor'>
<td><code><b>floor</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns a copy of the current point with floored coordinates (rounded down).</p>
</td>
</tr>
<tr id='point-ceil'>
<td><code><b>ceil</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns a copy of the current point with ceiled coordinates (rounded up).</p>
</td>
</tr>
<tr id='point-distanceto'>
<td><code><b>distanceTo</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>otherPoint</i>)</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the cartesian distance between the current and the given points.</p>
</td>
</tr>
<tr id='point-equals'>
<td><code><b>equals</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>otherPoint</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the given point has the same coordinates.</p>
</td>
</tr>
<tr id='point-contains'>
<td><code><b>contains</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>otherPoint</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if both coordinates of the given point are less than the corresponding current point coordinates (in absolute values).</p>
</td>
</tr>
<tr id='point-tostring'>
<td><code><b>toString</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Returns a string representation of the point for debugging purposes.</p>
</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='point-property'>Properties</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='point-x'>
<td><code><b>x</b>
<td><code>Number</code></td>
<td>The <code>x</code> coordinate of the point</td>
</tr>
<tr id='point-y'>
<td><code><b>y</b>
<td><code>Number</code></td>
<td>The <code>y</code> coordinate of the point</td>
</tr>
</tbody></table>
</section>
</section><h2 id='bounds'>Bounds</h2><p>Represents a rectangular area in pixel coordinates.</p>
<section>
<h3 id='bounds-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var p1 = L.point(10, 10),
p2 = L.point(40, 60),
bounds = L.bounds(p1, p2);
</code></pre>
<p>All Leaflet methods that accept <a href="#bounds"><code>Bounds</code></a> objects also accept them in a simple Array form (unless noted otherwise), so the bounds example above can be passed like this:</p>
<pre><code class="lang-js">otherBounds.intersects([[10, 10], [40, 60]]);
</code></pre>
</section>
</section><section>
<h3 id='bounds-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='bounds-l-bounds'>
<td><code><b>L.bounds</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>corner1</i>, <nobr><<a href='#point'>Point</a>></nobr> <i>corner2</i>)</nobr></code></td>
<td>Creates a Bounds object from two corners coordinate pairs.</td>
</tr>
<tr id='bounds-l-bounds'>
<td><code><b>L.bounds</b>(<nobr><Point[]></nobr> <i>points</i>)</nobr></code></td>
<td>Creates a Bounds object from the given array of points.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='bounds-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='bounds-extend'>
<td><code><b>extend</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>point</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Extends the bounds to contain the given point.</p>
</td>
</tr>
<tr id='bounds-getcenter'>
<td><code><b>getCenter</b>(<nobr><Boolean></nobr> <i>round?</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the center point of the bounds.</p>
</td>
</tr>
<tr id='bounds-getbottomleft'>
<td><code><b>getBottomLeft</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the bottom-left point of the bounds.</p>
</td>
</tr>
<tr id='bounds-gettopright'>
<td><code><b>getTopRight</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the top-right point of the bounds.</p>
</td>
</tr>
<tr id='bounds-gettopleft'>
<td><code><b>getTopLeft</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the top-left point of the bounds (i.e. <a href="#bounds-min"><code>this.min</code></a>).</p>
</td>
</tr>
<tr id='bounds-getbottomright'>
<td><code><b>getBottomRight</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the bottom-right point of the bounds (i.e. <a href="#bounds-max"><code>this.max</code></a>).</p>
</td>
</tr>
<tr id='bounds-getsize'>
<td><code><b>getSize</b>()</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the size of the given bounds</p>
</td>
</tr>
<tr id='bounds-contains'>
<td><code><b>contains</b>(<nobr><<a href='#bounds'>Bounds</a>></nobr> <i>otherBounds</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the rectangle contains the given one.</p>
</td>
</tr>
<tr id='bounds-contains'>
<td><code><b>contains</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>point</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the rectangle contains the given point.</p>
</td>
</tr>
<tr id='bounds-intersects'>
<td><code><b>intersects</b>(<nobr><<a href='#bounds'>Bounds</a>></nobr> <i>otherBounds</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the rectangle intersects the given bounds. Two bounds
intersect if they have at least one point in common.</p>
</td>
</tr>
<tr id='bounds-overlaps'>
<td><code><b>overlaps</b>(<nobr><<a href='#bounds'>Bounds</a>></nobr> <i>otherBounds</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the rectangle overlaps the given bounds. Two bounds
overlap if their intersection is an area.</p>
</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='bounds-property'>Properties</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='bounds-min'>
<td><code><b>min</b>
<td><code><a href='#point'>Point</a></code></td>
<td>The top left corner of the rectangle.</td>
</tr>
<tr id='bounds-max'>
<td><code><b>max</b>
<td><code><a href='#point'>Point</a></code></td>
<td>The bottom right corner of the rectangle.</td>
</tr>
</tbody></table>
</section>
</section><h2 id='icon'>Icon</h2><p>Represents an icon to provide when creating a marker.</p>
<section>
<h3 id='icon-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var myIcon = L.icon({
iconUrl: 'my-icon.png',
iconSize: [38, 95],
iconAnchor: [22, 94],
popupAnchor: [-3, -76],
shadowUrl: 'my-icon-shadow.png',
shadowSize: [68, 95],
shadowAnchor: [22, 94]
});
L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
</code></pre>
<p><a href="#icon-default"><code>L.Icon.Default</code></a> extends <a href="#icon"><code>L.Icon</code></a> and is the blue icon Leaflet uses for markers by default.</p>
</section>
</section><section>
<h3 id='icon-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='icon-l-icon'>
<td><code><b>L.icon</b>(<nobr><<a href='#icon-option'>Icon options</a>></nobr> <i>options</i>)</nobr></code></td>
<td>Creates an icon instance with the given options.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='icon-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='icon-iconurl'>
<td><code><b>iconUrl</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td><strong>(required)</strong> The URL to the icon image (absolute or relative to your script path).</td>
</tr>
<tr id='icon-iconretinaurl'>
<td><code><b>iconRetinaUrl</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>The URL to a retina sized version of the icon image (absolute or relative to your
script path). Used for Retina screen devices.</td>
</tr>
<tr id='icon-iconsize'>
<td><code><b>iconSize</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>null</code></td>
<td>Size of the icon image in pixels.</td>
</tr>
<tr id='icon-iconanchor'>
<td><code><b>iconAnchor</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>null</code></td>
<td>The coordinates of the "tip" of the icon (relative to its top left corner). The icon
will be aligned so that this point is at the marker's geographical location. Centered
by default if size is specified, also can be set in CSS with negative margins.</td>
</tr>
<tr id='icon-popupanchor'>
<td><code><b>popupAnchor</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>null</code></td>
<td>The coordinates of the point from which popups will "open", relative to the icon anchor.</td>
</tr>
<tr id='icon-shadowurl'>
<td><code><b>shadowUrl</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>The URL to the icon shadow image. If not specified, no shadow image will be created.</td>
</tr>
<tr id='icon-shadowretinaurl'>
<td><code><b>shadowRetinaUrl</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td></td>
</tr>
<tr id='icon-shadowsize'>
<td><code><b>shadowSize</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>null</code></td>
<td>Size of the shadow image in pixels.</td>
</tr>
<tr id='icon-shadowanchor'>
<td><code><b>shadowAnchor</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>null</code></td>
<td>The coordinates of the "tip" of the shadow (relative to its top left corner) (the same
as iconAnchor if not specified).</td>
</tr>
<tr id='icon-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>A custom class name to assign to both icon and shadow images. Empty by default.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='icon-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='icon-createicon'>
<td><code><b>createIcon</b>(<nobr><HTMLElement></nobr> <i>oldIcon?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Called internally when the icon has to be shown, returns a <code><img></code> HTML element
styled according to the options.</p>
</td>
</tr>
<tr id='icon-createshadow'>
<td><code><b>createShadow</b>(<nobr><HTMLElement></nobr> <i>oldIcon?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>As <code>createIcon</code>, but for the shadow beneath it.</p>
</td>
</tr>
</tbody></table>
</section>
</section><span id='icon-default'></span>
<section>
<h3 id='icon-default-option'>Icon.Default</h3>
<section >
<div class='section-comments'>A trivial subclass of <a href="#icon"><code>Icon</code></a>, represents the icon to use in <a href="#marker"><code>Marker</code></a>s when
no icon is specified. Points to the blue marker image distributed with Leaflet
releases.
In order to customize the default icon, just change the properties of <code>L.Icon.Default.prototype.options</code>
(which is a set of <a href="#icon-option"><code>Icon options</code></a>).
If you want to <em>completely</em> replace the default icon, override the
<code>L.Marker.prototype.options.icon</code> with your own icon instead.</div>
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='icon-default-imagepath'>
<td><code><b>imagePath</b></code></td>
<td><code>String</code>
<td><code></code></td>
<td><a href="#icon-default"><code>Icon.Default</code></a> will try to auto-detect the absolute location of the
blue icon images. If you are placing these images in a non-standard
way, set this option to point to the right absolute path.</td>
</tr>
</tbody></table>
</section>
</section><h2 id='divicon'>DivIcon</h2><p>Represents a lightweight icon for markers that uses a simple <code><div></code>
element instead of an image. Inherits from <a href="#icon"><code>Icon</code></a> but ignores the <code>iconUrl</code> and shadow options.</p>
<section>
<h3 id='divicon-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var myIcon = L.divIcon({className: 'my-div-icon'});
// you can set .my-div-icon styles in CSS
L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
</code></pre>
<p>By default, it has a 'leaflet-div-icon' CSS class and is styled as a little white square with a shadow.</p>
</section>
</section><section>
<h3 id='divicon-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divicon-l-divicon'>
<td><code><b>L.divIcon</b>(<nobr><<a href='#divicon-option'>DivIcon options</a>></nobr> <i>options</i>)</nobr></code></td>
<td>Creates a <a href="#divicon"><code>DivIcon</code></a> instance with the given options.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='divicon-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divicon-html'>
<td><code><b>html</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>Custom HTML code to put inside the div element, empty by default.</td>
</tr>
<tr id='divicon-bgpos'>
<td><code><b>bgPos</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>[0, 0]</code></td>
<td>Optional relative position of the background, in pixels</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#icon'>Icon</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divicon-iconurl'>
<td><code><b>iconUrl</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td><strong>(required)</strong> The URL to the icon image (absolute or relative to your script path).</td>
</tr>
<tr id='divicon-iconretinaurl'>
<td><code><b>iconRetinaUrl</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>The URL to a retina sized version of the icon image (absolute or relative to your
script path). Used for Retina screen devices.</td>
</tr>
<tr id='divicon-iconsize'>
<td><code><b>iconSize</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>null</code></td>
<td>Size of the icon image in pixels.</td>
</tr>
<tr id='divicon-iconanchor'>
<td><code><b>iconAnchor</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>null</code></td>
<td>The coordinates of the "tip" of the icon (relative to its top left corner). The icon
will be aligned so that this point is at the marker's geographical location. Centered
by default if size is specified, also can be set in CSS with negative margins.</td>
</tr>
<tr id='divicon-popupanchor'>
<td><code><b>popupAnchor</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>null</code></td>
<td>The coordinates of the point from which popups will "open", relative to the icon anchor.</td>
</tr>
<tr id='divicon-shadowurl'>
<td><code><b>shadowUrl</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>The URL to the icon shadow image. If not specified, no shadow image will be created.</td>
</tr>
<tr id='divicon-shadowretinaurl'>
<td><code><b>shadowRetinaUrl</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td></td>
</tr>
<tr id='divicon-shadowsize'>
<td><code><b>shadowSize</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>null</code></td>
<td>Size of the shadow image in pixels.</td>
</tr>
<tr id='divicon-shadowanchor'>
<td><code><b>shadowAnchor</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>null</code></td>
<td>The coordinates of the "tip" of the shadow (relative to its top left corner) (the same
as iconAnchor if not specified).</td>
</tr>
<tr id='divicon-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>A custom class name to assign to both icon and shadow images. Empty by default.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Methods</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#icon'>Icon</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divicon-createicon'>
<td><code><b>createIcon</b>(<nobr><HTMLElement></nobr> <i>oldIcon?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Called internally when the icon has to be shown, returns a <code><img></code> HTML element
styled according to the options.</p>
</td>
</tr>
<tr id='divicon-createshadow'>
<td><code><b>createShadow</b>(<nobr><HTMLElement></nobr> <i>oldIcon?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>As <code>createIcon</code>, but for the shadow beneath it.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='control-zoom'>Control.Zoom</h2><p>A basic zoom control with two buttons (zoom in and zoom out). It is put on the map by default unless you set its <a href="#map-zoomcontrol"><code>zoomControl</code> option</a> to <code>false</code>. Extends <a href="#control"><code>Control</code></a>.</p>
<section>
<h3 id='control-zoom-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-zoom-l-control-zoom'>
<td><code><b>L.control.zoom</b>(<nobr><<a href='#control-zoom-option'>Control.Zoom options</a>></nobr> <i>options</i>)</nobr></code></td>
<td>Creates a zoom control</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='control-zoom-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-zoom-zoomintext'>
<td><code><b>zoomInText</b></code></td>
<td><code>String</code>
<td><code>'+'</code></td>
<td>The text set on the 'zoom in' button.</td>
</tr>
<tr id='control-zoom-zoomintitle'>
<td><code><b>zoomInTitle</b></code></td>
<td><code>String</code>
<td><code>'Zoom in'</code></td>
<td>The title set on the 'zoom in' button.</td>
</tr>
<tr id='control-zoom-zoomouttext'>
<td><code><b>zoomOutText</b></code></td>
<td><code>String</code>
<td><code>'&#x2212</code></td>
<td>'
The text set on the 'zoom out' button.</td>
</tr>
<tr id='control-zoom-zoomouttitle'>
<td><code><b>zoomOutTitle</b></code></td>
<td><code>String</code>
<td><code>'Zoom out'</code></td>
<td>The title set on the 'zoom out' button.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#control'>Control</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-zoom-position'>
<td><code><b>position</b></code></td>
<td><code>String</code>
<td><code>'topright'</code></td>
<td>The position of the control (one of the map corners). Possible values are <code>'topleft'</code>,
<code>'topright'</code>, <code>'bottomleft'</code> or <code>'bottomright'</code></td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Methods</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#control'>Control</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-zoom-getposition'>
<td><code><b>getPosition</b>()</nobr></code></td>
<td><code>string</code></td>
<td><p>Returns the position of the control.</p>
</td>
</tr>
<tr id='control-zoom-setposition'>
<td><code><b>setPosition</b>(<nobr><string></nobr> <i>position</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the position of the control.</p>
</td>
</tr>
<tr id='control-zoom-getcontainer'>
<td><code><b>getContainer</b>()</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the HTMLElement that contains the control.</p>
</td>
</tr>
<tr id='control-zoom-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the control to the given map.</p>
</td>
</tr>
<tr id='control-zoom-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the control from the map it is currently active on.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='control-attribution'>Control.Attribution</h2><p>The attribution control allows you to display attribution data in a small text box on a map. It is put on the map by default unless you set its <a href="#map-attributioncontrol"><code>attributionControl</code> option</a> to <code>false</code>, and it fetches attribution texts from layers with the <a href="#layer-getattribution"><code>getAttribution</code> method</a> automatically. Extends Control.</p>
<section>
<h3 id='control-attribution-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-attribution-l-control-attribution'>
<td><code><b>L.control.attribution</b>(<nobr><<a href='#control-attribution-option'>Control.Attribution options</a>></nobr> <i>options</i>)</nobr></code></td>
<td>Creates an attribution control.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='control-attribution-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-attribution-prefix'>
<td><code><b>prefix</b></code></td>
<td><code>String</code>
<td><code>'Leaflet'</code></td>
<td>The HTML text shown before the attributions. Pass <code>false</code> to disable.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#control'>Control</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-attribution-position'>
<td><code><b>position</b></code></td>
<td><code>String</code>
<td><code>'topright'</code></td>
<td>The position of the control (one of the map corners). Possible values are <code>'topleft'</code>,
<code>'topright'</code>, <code>'bottomleft'</code> or <code>'bottomright'</code></td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='control-attribution-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-attribution-setprefix'>
<td><code><b>setPrefix</b>(<nobr><String></nobr> <i>prefix</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the text before the attributions.</p>
</td>
</tr>
<tr id='control-attribution-addattribution'>
<td><code><b>addAttribution</b>(<nobr><String></nobr> <i>text</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an attribution text (e.g. <code>'Vector data &copy; Mapbox'</code>).</p>
</td>
</tr>
<tr id='control-attribution-removeattribution'>
<td><code><b>removeAttribution</b>(<nobr><String></nobr> <i>text</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an attribution text.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#control'>Control</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-attribution-getposition'>
<td><code><b>getPosition</b>()</nobr></code></td>
<td><code>string</code></td>
<td><p>Returns the position of the control.</p>
</td>
</tr>
<tr id='control-attribution-setposition'>
<td><code><b>setPosition</b>(<nobr><string></nobr> <i>position</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the position of the control.</p>
</td>
</tr>
<tr id='control-attribution-getcontainer'>
<td><code><b>getContainer</b>()</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the HTMLElement that contains the control.</p>
</td>
</tr>
<tr id='control-attribution-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the control to the given map.</p>
</td>
</tr>
<tr id='control-attribution-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the control from the map it is currently active on.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='control-layers'>Control.Layers</h2><p>The layers control gives users the ability to switch between different base layers and switch overlays on/off (check out the <a href="http://leafletjs.com/examples/layers-control/">detailed example</a>). Extends <a href="#control"><code>Control</code></a>.</p>
<section>
<h3 id='control-layers-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var baseLayers = {
"Mapbox": mapbox,
"OpenStreetMap": osm
};
var overlays = {
"Marker": marker,
"Roads": roadsLayer
};
L.control.layers(baseLayers, overlays).addTo(map);
</code></pre>
<p>The <code>baseLayers</code> and <code>overlays</code> parameters are object literals with layer names as keys and <a href="#layer"><code>Layer</code></a> objects as values:</p>
<pre><code class="lang-js">{
"<someName1>": layer1,
"<someName2>": layer2
}
</code></pre>
<p>The layer names can contain HTML, which allows you to add additional styling to the items:</p>
<pre><code class="lang-js">{"<img src='my-layer-icon' /> <span class='my-layer-item'>My Layer</span>": myLayer}
</code></pre>
</section>
</section><section>
<h3 id='control-layers-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-layers-l-control-layers'>
<td><code><b>L.control.layers</b>(<nobr><Object></nobr> <i>baselayers?</i>, <nobr><Object></nobr> <i>overlays?</i>, <nobr><<a href='#control-layers-option'>Control.Layers options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Creates an attribution control with the given layers. Base layers will be switched with radio buttons, while overlays will be switched with checkboxes. Note that all base layers should be passed in the base layers object, but only one should be added to the map during map instantiation.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='control-layers-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-layers-collapsed'>
<td><code><b>collapsed</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>If <code>true</code>, the control will be collapsed into an icon and expanded on mouse hover or touch.</td>
</tr>
<tr id='control-layers-autozindex'>
<td><code><b>autoZIndex</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>If <code>true</code>, the control will assign zIndexes in increasing order to all of its layers so that the order is preserved when switching them on/off.</td>
</tr>
<tr id='control-layers-hidesinglebase'>
<td><code><b>hideSingleBase</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, the base layers in the control will be hidden when there is only one.</td>
</tr>
<tr id='control-layers-sortlayers'>
<td><code><b>sortLayers</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>Whether to sort the layers. When <code>false</code>, layers will keep the order
in which they were added to the control.</td>
</tr>
<tr id='control-layers-sortfunction'>
<td><code><b>sortFunction</b></code></td>
<td><code>Function</code>
<td><code>*</code></td>
<td>A <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/sort">compare function</a>
that will be used for sorting the layers, when <code>sortLayers</code> is <code>true</code>.
The function receives both the <a href="#layer"><code>L.Layer</code></a> instances and their names, as in
<code>sortFunction(layerA, layerB, nameA, nameB)</code>.
By default, it sorts layers alphabetically by their name.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#control'>Control</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-layers-position'>
<td><code><b>position</b></code></td>
<td><code>String</code>
<td><code>'topright'</code></td>
<td>The position of the control (one of the map corners). Possible values are <code>'topleft'</code>,
<code>'topright'</code>, <code>'bottomleft'</code> or <code>'bottomright'</code></td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='control-layers-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-layers-addbaselayer'>
<td><code><b>addBaseLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>, <nobr><String></nobr> <i>name</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a base layer (radio button entry) with the given name to the control.</p>
</td>
</tr>
<tr id='control-layers-addoverlay'>
<td><code><b>addOverlay</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>, <nobr><String></nobr> <i>name</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an overlay (checkbox entry) with the given name to the control.</p>
</td>
</tr>
<tr id='control-layers-removelayer'>
<td><code><b>removeLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Remove the given layer from the control.</p>
</td>
</tr>
<tr id='control-layers-expand'>
<td><code><b>expand</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Expand the control container if collapsed.</p>
</td>
</tr>
<tr id='control-layers-collapse'>
<td><code><b>collapse</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Collapse the control container if expanded.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#control'>Control</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-layers-getposition'>
<td><code><b>getPosition</b>()</nobr></code></td>
<td><code>string</code></td>
<td><p>Returns the position of the control.</p>
</td>
</tr>
<tr id='control-layers-setposition'>
<td><code><b>setPosition</b>(<nobr><string></nobr> <i>position</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the position of the control.</p>
</td>
</tr>
<tr id='control-layers-getcontainer'>
<td><code><b>getContainer</b>()</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the HTMLElement that contains the control.</p>
</td>
</tr>
<tr id='control-layers-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the control to the given map.</p>
</td>
</tr>
<tr id='control-layers-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the control from the map it is currently active on.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='control-scale'>Control.Scale</h2><p>A simple scale control that shows the scale of the current center of screen in metric (m/km) and imperial (mi/ft) systems. Extends <a href="#control"><code>Control</code></a>.</p>
<section>
<h3 id='control-scale-example'>Usage example</h3>
<section >
<pre><code class="lang-js">L.control.scale().addTo(map);
</code></pre>
</section>
</section><section>
<h3 id='control-scale-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-scale-l-control-scale'>
<td><code><b>L.control.scale</b>(<nobr><<a href='#control-scale-option'>Control.Scale options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Creates an scale control with the given options.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='control-scale-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-scale-maxwidth'>
<td><code><b>maxWidth</b></code></td>
<td><code>Number</code>
<td><code>100</code></td>
<td>Maximum width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500).</td>
</tr>
<tr id='control-scale-metric'>
<td><code><b>metric</b></code></td>
<td><code>Boolean</code>
<td><code>True</code></td>
<td>Whether to show the metric scale line (m/km).</td>
</tr>
<tr id='control-scale-imperial'>
<td><code><b>imperial</b></code></td>
<td><code>Boolean</code>
<td><code>True</code></td>
<td>Whether to show the imperial scale line (mi/ft).</td>
</tr>
<tr id='control-scale-updatewhenidle'>
<td><code><b>updateWhenIdle</b></code></td>
<td><code>Boolean</code>
<td><code>false</code></td>
<td>If <code>true</code>, the control is updated on <a href="#map-moveend"><code>moveend</code></a>, otherwise it's always up-to-date (updated on <a href="#map-move"><code>move</code></a>).</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#control'>Control</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-scale-position'>
<td><code><b>position</b></code></td>
<td><code>String</code>
<td><code>'topright'</code></td>
<td>The position of the control (one of the map corners). Possible values are <code>'topleft'</code>,
<code>'topright'</code>, <code>'bottomleft'</code> or <code>'bottomright'</code></td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Methods</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#control'>Control</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-scale-getposition'>
<td><code><b>getPosition</b>()</nobr></code></td>
<td><code>string</code></td>
<td><p>Returns the position of the control.</p>
</td>
</tr>
<tr id='control-scale-setposition'>
<td><code><b>setPosition</b>(<nobr><string></nobr> <i>position</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the position of the control.</p>
</td>
</tr>
<tr id='control-scale-getcontainer'>
<td><code><b>getContainer</b>()</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the HTMLElement that contains the control.</p>
</td>
</tr>
<tr id='control-scale-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the control to the given map.</p>
</td>
</tr>
<tr id='control-scale-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the control from the map it is currently active on.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='browser'>Browser</h2><p>A namespace with static properties for browser/feature detection used by Leaflet internally.</p>
<section>
<h3 id='browser-example'>Usage example</h3>
<section >
<pre><code class="lang-js">if (L.Browser.ielt9) {
alert('Upgrade your browser, dude!');
}
</code></pre>
</section>
</section><section>
<h3 id='browser-property'>Properties</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='browser-ie'>
<td><code><b>ie</b>
<td><code>Boolean</code></td>
<td><code>true</code> for all Internet Explorer versions (not Edge).</td>
</tr>
<tr id='browser-ielt9'>
<td><code><b>ielt9</b>
<td><code>Boolean</code></td>
<td><code>true</code> for Internet Explorer versions less than 9.</td>
</tr>
<tr id='browser-edge'>
<td><code><b>edge</b>
<td><code>Boolean</code></td>
<td><code>true</code> for the Edge web browser.</td>
</tr>
<tr id='browser-webkit'>
<td><code><b>webkit</b>
<td><code>Boolean</code></td>
<td><code>true</code> for webkit-based browsers like Chrome and Safari (including mobile versions).</td>
</tr>
<tr id='browser-android'>
<td><code><b>android</b>
<td><code>Boolean</code></td>
<td><code>true</code> for any browser running on an Android platform.</td>
</tr>
<tr id='browser-android23'>
<td><code><b>android23</b>
<td><code>Boolean</code></td>
<td><code>true</code> for browsers running on Android 2 or Android 3.</td>
</tr>
<tr id='browser-opera'>
<td><code><b>opera</b>
<td><code>Boolean</code></td>
<td><code>true</code> for the Opera browser</td>
</tr>
<tr id='browser-chrome'>
<td><code><b>chrome</b>
<td><code>Boolean</code></td>
<td><code>true</code> for the Chrome browser.</td>
</tr>
<tr id='browser-gecko'>
<td><code><b>gecko</b>
<td><code>Boolean</code></td>
<td><code>true</code> for gecko-based browsers like Firefox.</td>
</tr>
<tr id='browser-safari'>
<td><code><b>safari</b>
<td><code>Boolean</code></td>
<td><code>true</code> for the Safari browser.</td>
</tr>
<tr id='browser-opera12'>
<td><code><b>opera12</b>
<td><code>Boolean</code></td>
<td><code>true</code> for the Opera browser supporting CSS transforms (version 12 or later).</td>
</tr>
<tr id='browser-win'>
<td><code><b>win</b>
<td><code>Boolean</code></td>
<td><code>true</code> when the browser is running in a Windows platform</td>
</tr>
<tr id='browser-ie3d'>
<td><code><b>ie3d</b>
<td><code>Boolean</code></td>
<td><code>true</code> for all Internet Explorer versions supporting CSS transforms.</td>
</tr>
<tr id='browser-webkit3d'>
<td><code><b>webkit3d</b>
<td><code>Boolean</code></td>
<td><code>true</code> for webkit-based browsers supporting CSS transforms.</td>
</tr>
<tr id='browser-gecko3d'>
<td><code><b>gecko3d</b>
<td><code>Boolean</code></td>
<td><code>true</code> for gecko-based browsers supporting CSS transforms.</td>
</tr>
<tr id='browser-any3d'>
<td><code><b>any3d</b>
<td><code>Boolean</code></td>
<td><code>true</code> for all browsers supporting CSS transforms.</td>
</tr>
<tr id='browser-mobile'>
<td><code><b>mobile</b>
<td><code>Boolean</code></td>
<td><code>true</code> for all browsers running in a mobile device.</td>
</tr>
<tr id='browser-mobilewebkit'>
<td><code><b>mobileWebkit</b>
<td><code>Boolean</code></td>
<td><code>true</code> for all webkit-based browsers in a mobile device.</td>
</tr>
<tr id='browser-mobilewebkit3d'>
<td><code><b>mobileWebkit3d</b>
<td><code>Boolean</code></td>
<td><code>true</code> for all webkit-based browsers in a mobile device supporting CSS transforms.</td>
</tr>
<tr id='browser-mspointer'>
<td><code><b>msPointer</b>
<td><code>Boolean</code></td>
<td><code>true</code> for browsers implementing the Microsoft touch events model (notably IE10).</td>
</tr>
<tr id='browser-pointer'>
<td><code><b>pointer</b>
<td><code>Boolean</code></td>
<td><code>true</code> for all browsers supporting <a href="https://msdn.microsoft.com/en-us/library/dn433244%28v=vs.85%29.aspx">pointer events</a>.</td>
</tr>
<tr id='browser-touch'>
<td><code><b>touch</b>
<td><code>Boolean</code></td>
<td><code>true</code> for all browsers supporting <a href="https://developer.mozilla.org/docs/Web/API/Touch_events">touch events</a>.
This does not necessarily mean that the browser is running in a computer with
a touchscreen, it only means that the browser is capable of understanding
touch events.</td>
</tr>
<tr id='browser-mobileopera'>
<td><code><b>mobileOpera</b>
<td><code>Boolean</code></td>
<td><code>true</code> for the Opera browser in a mobile device.</td>
</tr>
<tr id='browser-mobilegecko'>
<td><code><b>mobileGecko</b>
<td><code>Boolean</code></td>
<td><code>true</code> for gecko-based browsers running in a mobile device.</td>
</tr>
<tr id='browser-retina'>
<td><code><b>retina</b>
<td><code>Boolean</code></td>
<td><code>true</code> for browsers on a high-resolution "retina" screen.</td>
</tr>
<tr id='browser-canvas'>
<td><code><b>canvas</b>
<td><code>Boolean</code></td>
<td><code>true</code> when the browser supports <a href="https://developer.mozilla.org/docs/Web/API/Canvas_API"><code><canvas></code></a>.</td>
</tr>
<tr id='browser-svg'>
<td><code><b>svg</b>
<td><code>Boolean</code></td>
<td><code>true</code> when the browser supports <a href="https://developer.mozilla.org/docs/Web/SVG">SVG</a>.</td>
</tr>
<tr id='browser-vml'>
<td><code><b>vml</b>
<td><code>Boolean</code></td>
<td><code>true</code> if the browser supports <a href="https://en.wikipedia.org/wiki/Vector_Markup_Language">VML</a>.</td>
</tr>
</tbody></table>
</section>
</section><h2 id='util'>Util</h2><p>Various utility functions, used by Leaflet internally.</p>
<section>
<h3 id='util-function'>Functions</h3>
<section >
<table><thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='util-extend'>
<td><code><b>extend</b>(<nobr><Object></nobr> <i>dest</i>, <nobr><Object></nobr> <i>src?</i>)</nobr></code></td>
<td><code>Object</code></td>
<td>Merges the properties of the <code>src</code> object (or multiple objects) into <code>dest</code> object and returns the latter. Has an <code>L.extend</code> shortcut.</td>
</tr>
<tr id='util-create'>
<td><code><b>create</b>(<nobr><Object></nobr> <i>proto</i>, <nobr><Object></nobr> <i>properties?</i>)</nobr></code></td>
<td><code>Object</code></td>
<td>Compatibility polyfill for <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/create">Object.create</a></td>
</tr>
<tr id='util-bind'>
<td><code><b>bind</b>(<nobr><Function></nobr> <i>fn</i>, <i>…</i>)</nobr></code></td>
<td><code>Function</code></td>
<td>Returns a new function bound to the arguments passed, like <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function/bind">Function.prototype.bind</a>.
Has a <code>L.bind()</code> shortcut.</td>
</tr>
<tr id='util-stamp'>
<td><code><b>stamp</b>(<nobr><Object></nobr> <i>obj</i>)</nobr></code></td>
<td><code>Number</code></td>
<td>Returns the unique ID of an object, assiging it one if it doesn't have it.</td>
</tr>
<tr id='util-throttle'>
<td><code><b>throttle</b>(<nobr><Function></nobr> <i>fn</i>, <nobr><Number></nobr> <i>time</i>, <nobr><Object></nobr> <i>context</i>)</nobr></code></td>
<td><code>Function</code></td>
<td>Returns a function which executes function <code>fn</code> with the given scope <code>context</code>
(so that the <code>this</code> keyword refers to <code>context</code> inside <code>fn</code>'s code). The function
<code>fn</code> will be called no more than one time per given amount of <code>time</code>. The arguments
received by the bound function will be any arguments passed when binding the
function, followed by any arguments passed when invoking the bound function.
Has an <code>L.throttle</code> shortcut.</td>
</tr>
<tr id='util-wrapnum'>
<td><code><b>wrapNum</b>(<nobr><Number></nobr> <i>num</i>, <nobr><Number[]></nobr> <i>range</i>, <nobr><Boolean></nobr> <i>includeMax?</i>)</nobr></code></td>
<td><code>Number</code></td>
<td>Returns the number <code>num</code> modulo <code>range</code> in such a way so it lies within
<code>range[0]</code> and <code>range[1]</code>. The returned value will be always smaller than
<code>range[1]</code> unless <code>includeMax</code> is set to <code>true</code>.</td>
</tr>
<tr id='util-falsefn'>
<td><code><b>falseFn</b>()</nobr></code></td>
<td><code>Function</code></td>
<td>Returns a function which always returns <code>false</code>.</td>
</tr>
<tr id='util-formatnum'>
<td><code><b>formatNum</b>(<nobr><Number></nobr> <i>num</i>, <nobr><Number></nobr> <i>digits?</i>)</nobr></code></td>
<td><code>Number</code></td>
<td>Returns the number <code>num</code> rounded to <code>digits</code> decimals, or to 5 decimals by default.</td>
</tr>
<tr id='util-trim'>
<td><code><b>trim</b>(<nobr><String></nobr> <i>str</i>)</nobr></code></td>
<td><code>String</code></td>
<td>Compatibility polyfill for <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String/Trim">String.prototype.trim</a></td>
</tr>
<tr id='util-splitwords'>
<td><code><b>splitWords</b>(<nobr><String></nobr> <i>str</i>)</nobr></code></td>
<td><code>String[]</code></td>
<td>Trims and splits the string on whitespace and returns the array of parts.</td>
</tr>
<tr id='util-setoptions'>
<td><code><b>setOptions</b>(<nobr><Object></nobr> <i>obj</i>, <nobr><Object></nobr> <i>options</i>)</nobr></code></td>
<td><code>Object</code></td>
<td>Merges the given properties to the <code>options</code> of the <code>obj</code> object, returning the resulting options. See <code>Class options</code>. Has an <code>L.setOptions</code> shortcut.</td>
</tr>
<tr id='util-getparamstring'>
<td><code><b>getParamString</b>(<nobr><Object></nobr> <i>obj</i>, <nobr><String></nobr> <i>existingUrl?</i>, <nobr><Boolean></nobr> <i>uppercase?</i>)</nobr></code></td>
<td><code>String</code></td>
<td>Converts an object into a parameter URL string, e.g. <code>{a: "foo", b: "bar"}</code>
translates to <code>'?a=foo&b=bar'</code>. If <code>existingUrl</code> is set, the parameters will
be appended at the end. If <code>uppercase</code> is <code>true</code>, the parameter names will
be uppercased (e.g. <code>'?A=foo&B=bar'</code>)</td>
</tr>
<tr id='util-template'>
<td><code><b>template</b>(<nobr><String></nobr> <i>str</i>, <nobr><Object></nobr> <i>data</i>)</nobr></code></td>
<td><code>String</code></td>
<td>Simple templating facility, accepts a template string of the form <code>'Hello {a}, {b}'</code>
and a data object like <code>{a: 'foo', b: 'bar'}</code>, returns evaluated string
<code>('Hello foo, bar')</code>. You can also specify functions instead of strings for
data values — they will be evaluated passing <code>data</code> as an argument.</td>
</tr>
<tr id='util-isarray'>
<td><code><b>isArray</b>(<i>obj</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td>Compatibility polyfill for <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray">Array.isArray</a></td>
</tr>
<tr id='util-indexof'>
<td><code><b>indexOf</b>(<nobr><Array></nobr> <i>array</i>, <nobr><Object></nobr> <i>el</i>)</nobr></code></td>
<td><code>Number</code></td>
<td>Compatibility polyfill for <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf">Array.prototype.indexOf</a></td>
</tr>
<tr id='util-requestanimframe'>
<td><code><b>requestAnimFrame</b>(<nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>, <nobr><Boolean></nobr> <i>immediate?</i>)</nobr></code></td>
<td><code>Number</code></td>
<td>Schedules <code>fn</code> to be executed when the browser repaints. <code>fn</code> is bound to
<code>context</code> if given. When <code>immediate</code> is set, <code>fn</code> is called immediately if
the browser doesn't have native support for
<a href="https://developer.mozilla.org/docs/Web/API/window/requestAnimationFrame"><code>window.requestAnimationFrame</code></a>,
otherwise it's delayed. Returns a request ID that can be used to cancel the request.</td>
</tr>
<tr id='util-cancelanimframe'>
<td><code><b>cancelAnimFrame</b>(<nobr><Number></nobr> <i>id</i>)</nobr></code></td>
<td><code>undefined</code></td>
<td>Cancels a previous <code>requestAnimFrame</code>. See also <a href="https://developer.mozilla.org/docs/Web/API/window/cancelAnimationFrame">window.cancelAnimationFrame</a>.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='util-property'>Properties</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='util-lastid'>
<td><code><b>lastId</b>
<td><code>Number</code></td>
<td>Last unique ID used by <a href="#util-stamp"><code>stamp()</code></a></td>
</tr>
<tr id='util-emptyimageurl'>
<td><code><b>emptyImageUrl</b>
<td><code>String</code></td>
<td>Data URI string containing a base64-encoded empty GIF image.
Used as a hack to free memory from unused images on WebKit-powered
mobile devices (by setting image <code>src</code> to this string).</td>
</tr>
</tbody></table>
</section>
</section><h2 id='transformation'>Transformation</h2><p>Represents an affine transformation: a set of coefficients <code>a</code>, <code>b</code>, <code>c</code>, <code>d</code>
for transforming a point of a form <code>(x, y)</code> into <code>(a*x + b, c*y + d)</code> and doing
the reverse. Used by Leaflet in its projections code.</p>
<section>
<h3 id='transformation-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var transformation = L.transformation(2, 5, -1, 10),
p = L.point(1, 2),
p2 = transformation.transform(p), // L.point(7, 8)
p3 = transformation.untransform(p2); // L.point(1, 2)
</code></pre>
</section>
</section><section>
<h3 id='transformation-factory'>Creation</h3>
<section >
<table><thead>
<tr>
<th>Factory</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='transformation-l-transformation'>
<td><code><b>L.transformation</b>(<nobr><Number></nobr> <i>a</i>, <nobr><Number></nobr> <i>b</i>, <nobr><Number></nobr> <i>c</i>, <nobr><Number></nobr> <i>d</i>)</nobr></code></td>
<td>Instantiates a Transformation object with the given coefficients.</td>
</tr>
<tr id='transformation-l-transformation'>
<td><code><b>L.transformation</b>(<nobr><Array></nobr> <i>coefficients</i>)</nobr></code></td>
<td>Expects an coeficients array of the form
<code>[a: Number, b: Number, c: Number, d: Number]</code>.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='transformation-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='transformation-transform'>
<td><code><b>transform</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>point</i>, <nobr><Number></nobr> <i>scale?</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns a transformed point, optionally multiplied by the given scale.
Only accepts actual <a href="#point"><code>L.Point</code></a> instances, not arrays.</p>
</td>
</tr>
<tr id='transformation-untransform'>
<td><code><b>untransform</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>point</i>, <nobr><Number></nobr> <i>scale?</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Returns the reverse transformation of the given point, optionally divided
by the given scale. Only accepts actual <a href="#point"><code>L.Point</code></a> instances, not arrays.</p>
</td>
</tr>
</tbody></table>
</section>
</section><h2 id='lineutil'>LineUtil</h2><p>Various utility functions for polyine points processing, used by Leaflet internally to make polylines lightning-fast.</p>
<section>
<h3 id='lineutil-function'>Functions</h3>
<section >
<table><thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='lineutil-simplify'>
<td><code><b>simplify</b>(<nobr><Point[]></nobr> <i>points</i>, <nobr><Number></nobr> <i>tolerance</i>)</nobr></code></td>
<td><code>Point[]</code></td>
<td>Dramatically reduces the number of points in a polyline while retaining
its shape and returns a new array of simplified points, using the
<a href="http://en.wikipedia.org/wiki/Douglas-Peucker_algorithm">Douglas-Peucker algorithm</a>.
Used for a huge performance boost when processing/displaying Leaflet polylines for
each zoom level and also reducing visual noise. tolerance affects the amount of
simplification (lesser value means higher quality but slower and with more points).
Also released as a separated micro-library <a href="http://mourner.github.com/simplify-js/">Simplify.js</a>.</td>
</tr>
<tr id='lineutil-pointtosegmentdistance'>
<td><code><b>pointToSegmentDistance</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>p</i>, <nobr><<a href='#point'>Point</a>></nobr> <i>p1</i>, <nobr><<a href='#point'>Point</a>></nobr> <i>p2</i>)</nobr></code></td>
<td><code>Number</code></td>
<td>Returns the distance between point <code>p</code> and segment <code>p1</code> to <code>p2</code>.</td>
</tr>
<tr id='lineutil-closestpointonsegment'>
<td><code><b>closestPointOnSegment</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>p</i>, <nobr><<a href='#point'>Point</a>></nobr> <i>p1</i>, <nobr><<a href='#point'>Point</a>></nobr> <i>p2</i>)</nobr></code></td>
<td><code>Number</code></td>
<td>Returns the closest point from a point <code>p</code> on a segment <code>p1</code> to <code>p2</code>.</td>
</tr>
<tr id='lineutil-clipsegment'>
<td><code><b>clipSegment</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>a</i>, <nobr><<a href='#point'>Point</a>></nobr> <i>b</i>, <nobr><<a href='#bounds'>Bounds</a>></nobr> <i>bounds</i>, <nobr><Boolean></nobr> <i>useLastCode?</i>, <nobr><Boolean></nobr> <i>round?</i>)</nobr></code></td>
<td><code>Point[]|Boolean</code></td>
<td>Clips the segment a to b by rectangular bounds with the
<a href="https://en.wikipedia.org/wiki/Cohen%E2%80%93Sutherland_algorithm">Cohen-Sutherland algorithm</a>
(modifying the segment points directly!). Used by Leaflet to only show polyline
points that are on the screen or near, increasing performance.</td>
</tr>
</tbody></table>
</section>
</section><h2 id='polyutil'>PolyUtil</h2><p>Various utility functions for polygon geometries.</p>
<section>
<h3 id='polyutil-function'>Functions</h3>
<section >
<table><thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='polyutil-clippolygon'>
<td><code><b>clipPolygon</b>(<nobr><Point[]></nobr> <i>points</i>, <nobr><<a href='#bounds'>Bounds</a>></nobr> <i>bounds</i>, <nobr><Boolean></nobr> <i>round?</i>)</nobr></code></td>
<td><code>Point[]</code></td>
<td>Clips the polygon geometry defined by the given <code>points</code> by the given bounds (using the <a href="https://en.wikipedia.org/wiki/Sutherland%E2%80%93Hodgman_algorithm">Sutherland-Hodgeman algorithm</a>).
Used by Leaflet to only show polygon points that are on the screen or near, increasing
performance. Note that polygon points needs different algorithm for clipping
than polyline, so there's a seperate method for it.</td>
</tr>
</tbody></table>
</section>
</section><h2 id='domevent'>DomEvent</h2><p>Utility functions to work with the <a href="https://developer.mozilla.org/docs/Web/API/Event">DOM events</a>, used by Leaflet internally.</p>
<section>
<h3 id='domevent-function'>Functions</h3>
<section >
<table><thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='domevent-on'>
<td><code><b>on</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><String></nobr> <i>types</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Adds a listener function (<code>fn</code>) to a particular DOM event type of the
element <code>el</code>. You can optionally specify the context of the listener
(object the <code>this</code> keyword will point to). You can also pass several
space-separated types (e.g. <code>'click dblclick'</code>).</td>
</tr>
<tr id='domevent-on'>
<td><code><b>on</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><Object></nobr> <i>eventMap</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></td>
</tr>
<tr id='domevent-off'>
<td><code><b>off</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><String></nobr> <i>types</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Removes a previously added listener function. If no function is specified,
it will remove all the listeners of that particular DOM event from the element.
Note that if you passed a custom context to on, you must pass the same
context to <code>off</code> in order to remove the listener.</td>
</tr>
<tr id='domevent-off'>
<td><code><b>off</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><Object></nobr> <i>eventMap</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Removes a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></td>
</tr>
<tr id='domevent-off'>
<td><code><b>off</b>(<nobr><HTMLElement></nobr> <i>el</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Removes all known event listeners</td>
</tr>
<tr id='domevent-stoppropagation'>
<td><code><b>stopPropagation</b>(<nobr><DOMEvent></nobr> <i>ev</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Stop the given event from propagation to parent elements. Used inside the listener functions:
<pre><code class="lang-js">L.DomEvent.on(div, 'click', function (ev) {
L.DomEvent.stopPropagation(ev);
});
</code></pre></td>
</tr>
<tr id='domevent-disablescrollpropagation'>
<td><code><b>disableScrollPropagation</b>(<nobr><HTMLElement></nobr> <i>el</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Adds <code>stopPropagation</code> to the element's <code>'mousewheel'</code> events (plus browser variants).</td>
</tr>
<tr id='domevent-disableclickpropagation'>
<td><code><b>disableClickPropagation</b>(<nobr><HTMLElement></nobr> <i>el</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Adds <code>stopPropagation</code> to the element's <code>'click'</code>, <code>'doubleclick'</code>,
<code>'mousedown'</code> and <code>'touchstart'</code> events (plus browser variants).</td>
</tr>
<tr id='domevent-preventdefault'>
<td><code><b>preventDefault</b>(<nobr><DOMEvent></nobr> <i>ev</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Prevents the default action of the DOM Event <code>ev</code> from happening (such as
following a link in the href of the a element, or doing a POST request
with page reload when a <code><form></code> is submitted).
Use it inside listener functions.</td>
</tr>
<tr id='domevent-stop'>
<td><code><b>stop</b>(<i>ev</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Does <code>stopPropagation</code> and <code>preventDefault</code> at the same time.</td>
</tr>
<tr id='domevent-getmouseposition'>
<td><code><b>getMousePosition</b>(<nobr><DOMEvent></nobr> <i>ev</i>, <nobr><HTMLElement></nobr> <i>container?</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td>Gets normalized mouse position from a DOM event relative to the
<code>container</code> or to the whole page if not specified.</td>
</tr>
<tr id='domevent-getwheeldelta'>
<td><code><b>getWheelDelta</b>(<nobr><DOMEvent></nobr> <i>ev</i>)</nobr></code></td>
<td><code>Number</code></td>
<td>Gets normalized wheel delta from a mousewheel DOM event, in vertical
pixels scrolled (negative if scrolling down).
Events from pointing devices without precise scrolling are mapped to
a best guess of 60 pixels.</td>
</tr>
<tr id='domevent-addlistener'>
<td><code><b>addListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Alias to <a href="#domevent-on"><code>L.DomEvent.on</code></a></td>
</tr>
<tr id='domevent-removelistener'>
<td><code><b>removeListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Alias to <a href="#domevent-off"><code>L.DomEvent.off</code></a></td>
</tr>
</tbody></table>
</section>
</section><h2 id='domutil'>DomUtil</h2><p>Utility functions to work with the <a href="https://developer.mozilla.org/docs/Web/API/Document_Object_Model">DOM</a>
tree, used by Leaflet internally.
Most functions expecting or returning a <code>HTMLElement</code> also work for
SVG elements. The only difference is that classes refer to CSS classes
in HTML and SVG classes in SVG.</p>
<section>
<h3 id='domutil-function'>Functions</h3>
<section >
<table><thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='domutil-get'>
<td><code><b>get</b>(<nobr><String|HTMLElement></nobr> <i>id</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td>Returns an element given its DOM id, or returns the element itself
if it was passed directly.</td>
</tr>
<tr id='domutil-getstyle'>
<td><code><b>getStyle</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><String></nobr> <i>styleAttrib</i>)</nobr></code></td>
<td><code>String</code></td>
<td>Returns the value for a certain style attribute on an element,
including computed values or values set through CSS.</td>
</tr>
<tr id='domutil-create'>
<td><code><b>create</b>(<nobr><String></nobr> <i>tagName</i>, <nobr><String></nobr> <i>className?</i>, <nobr><HTMLElement></nobr> <i>container?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td>Creates an HTML element with <code>tagName</code>, sets its class to <code>className</code>, and optionally appends it to <code>container</code> element.</td>
</tr>
<tr id='domutil-remove'>
<td><code><b>remove</b>(<nobr><HTMLElement></nobr> <i>el</i>)</nobr></code></td>
<td><code></code></td>
<td>Removes <code>el</code> from its parent element</td>
</tr>
<tr id='domutil-empty'>
<td><code><b>empty</b>(<nobr><HTMLElement></nobr> <i>el</i>)</nobr></code></td>
<td><code></code></td>
<td>Removes all of <code>el</code>'s children elements from <code>el</code></td>
</tr>
<tr id='domutil-tofront'>
<td><code><b>toFront</b>(<nobr><HTMLElement></nobr> <i>el</i>)</nobr></code></td>
<td><code></code></td>
<td>Makes <code>el</code> the last child of its parent, so it renders in front of the other children.</td>
</tr>
<tr id='domutil-toback'>
<td><code><b>toBack</b>(<nobr><HTMLElement></nobr> <i>el</i>)</nobr></code></td>
<td><code></code></td>
<td>Makes <code>el</code> the first child of its parent, so it renders behind the other children.</td>
</tr>
<tr id='domutil-hasclass'>
<td><code><b>hasClass</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><String></nobr> <i>name</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td>Returns <code>true</code> if the element's class attribute contains <code>name</code>.</td>
</tr>
<tr id='domutil-addclass'>
<td><code><b>addClass</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><String></nobr> <i>name</i>)</nobr></code></td>
<td><code></code></td>
<td>Adds <code>name</code> to the element's class attribute.</td>
</tr>
<tr id='domutil-removeclass'>
<td><code><b>removeClass</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><String></nobr> <i>name</i>)</nobr></code></td>
<td><code></code></td>
<td>Removes <code>name</code> from the element's class attribute.</td>
</tr>
<tr id='domutil-setclass'>
<td><code><b>setClass</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><String></nobr> <i>name</i>)</nobr></code></td>
<td><code></code></td>
<td>Sets the element's class.</td>
</tr>
<tr id='domutil-getclass'>
<td><code><b>getClass</b>(<nobr><HTMLElement></nobr> <i>el</i>)</nobr></code></td>
<td><code>String</code></td>
<td>Returns the element's class.</td>
</tr>
<tr id='domutil-setopacity'>
<td><code><b>setOpacity</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><Number></nobr> <i>opacity</i>)</nobr></code></td>
<td><code></code></td>
<td>Set the opacity of an element (including old IE support).
<code>opacity</code> must be a number from <code>0</code> to <code>1</code>.</td>
</tr>
<tr id='domutil-testprop'>
<td><code><b>testProp</b>(<nobr><String[]></nobr> <i>props</i>)</nobr></code></td>
<td><code>String|false</code></td>
<td>Goes through the array of style names and returns the first name
that is a valid style name for an element. If no such name is found,
it returns false. Useful for vendor-prefixed styles like <code>transform</code>.</td>
</tr>
<tr id='domutil-settransform'>
<td><code><b>setTransform</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><<a href='#point'>Point</a>></nobr> <i>offset</i>, <nobr><Number></nobr> <i>scale?</i>)</nobr></code></td>
<td><code></code></td>
<td>Resets the 3D CSS transform of <code>el</code> so it is translated by <code>offset</code> pixels
and optionally scaled by <code>scale</code>. Does not have an effect if the
browser doesn't support 3D CSS transforms.</td>
</tr>
<tr id='domutil-setposition'>
<td><code><b>setPosition</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><<a href='#point'>Point</a>></nobr> <i>position</i>)</nobr></code></td>
<td><code></code></td>
<td>Sets the position of <code>el</code> to coordinates specified by <code>position</code>,
using CSS translate or top/left positioning depending on the browser
(used by Leaflet internally to position its layers).</td>
</tr>
<tr id='domutil-getposition'>
<td><code><b>getPosition</b>(<nobr><HTMLElement></nobr> <i>el</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td>Returns the coordinates of an element previously positioned with setPosition.</td>
</tr>
<tr id='domutil-disabletextselection'>
<td><code><b>disableTextSelection</b>()</nobr></code></td>
<td><code></code></td>
<td>Prevents the user from generating <code>selectstart</code> DOM events, usually generated
when the user drags the mouse through a page with text. Used internally
by Leaflet to override the behaviour of any click-and-drag interaction on
the map. Affects drag interactions on the whole document.</td>
</tr>
<tr id='domutil-enabletextselection'>
<td><code><b>enableTextSelection</b>()</nobr></code></td>
<td><code></code></td>
<td>Cancels the effects of a previous <a href="#domutil-disabletextselection"><code>L.DomUtil.disableTextSelection</code></a>.</td>
</tr>
<tr id='domutil-disableimagedrag'>
<td><code><b>disableImageDrag</b>()</nobr></code></td>
<td><code></code></td>
<td>As <a href="#domutil-disabletextselection"><code>L.DomUtil.disableTextSelection</code></a>, but
for <code>dragstart</code> DOM events, usually generated when the user drags an image.</td>
</tr>
<tr id='domutil-enableimagedrag'>
<td><code><b>enableImageDrag</b>()</nobr></code></td>
<td><code></code></td>
<td>Cancels the effects of a previous <a href="#domutil-disabletextselection"><code>L.DomUtil.disableImageDrag</code></a>.</td>
</tr>
<tr id='domutil-preventoutline'>
<td><code><b>preventOutline</b>(<nobr><HTMLElement></nobr> <i>el</i>)</nobr></code></td>
<td><code></code></td>
<td>Makes the <a href="https://developer.mozilla.org/docs/Web/CSS/outline">outline</a>
of the element <code>el</code> invisible. Used internally by Leaflet to prevent
focusable elements from displaying an outline when the user performs a
drag interaction on them.</td>
</tr>
<tr id='domutil-restoreoutline'>
<td><code><b>restoreOutline</b>()</nobr></code></td>
<td><code></code></td>
<td>Cancels the effects of a previous <a href=""><code>L.DomUtil.preventOutline</code></a>.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='domutil-property'>Properties</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='domutil-transform'>
<td><code><b>TRANSFORM</b>
<td><code>String</code></td>
<td>Vendor-prefixed transform style name (e.g. <code>'webkitTransform'</code> for WebKit).</td>
</tr>
<tr id='domutil-transition'>
<td><code><b>TRANSITION</b>
<td><code>String</code></td>
<td>Vendor-prefixed transition style name.</td>
</tr>
<tr id='domutil-transition_end'>
<td><code><b>TRANSITION_END</b>
<td><code>String</code></td>
<td>Vendor-prefixed transitionend event name.</td>
</tr>
</tbody></table>
</section>
</section><h2 id='posanimation'>PosAnimation</h2><p>Used internally for panning animations, utilizing CSS3 Transitions for modern browsers and a timer fallback for IE6-9.</p>
<section>
<h3 id='posanimation-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var fx = new L.PosAnimation();
fx.run(el, [300, 500], 0.5);
</code></pre>
</section>
</section><section>
<h3 id='posanimation-constructor'>Constructor</h3>
<section >
<table><thead>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='posanimation-l-posanimation'>
<td><code><b>L.PosAnimation</b>()</nobr></code></td>
<td>Creates a <a href="#posanimation"><code>PosAnimation</code></a> object.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='posanimation-event'>Events</h3>
<section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='posanimation-start'>
<td><code><b>start</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the animation starts</td>
</tr>
<tr id='posanimation-step'>
<td><code><b>step</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired continuously during the animation.</td>
</tr>
<tr id='posanimation-end'>
<td><code><b>end</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the animation ends.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='posanimation-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='posanimation-run'>
<td><code><b>run</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><<a href='#point'>Point</a>></nobr> <i>newPos</i>, <nobr><Number></nobr> <i>duration?</i>, <nobr><Number></nobr> <i>easeLinearity?</i>)</nobr></code></td>
<td><code></code></td>
<td><p>Run an animation of a given element to a new position, optionally setting
duration in seconds (<code>0.25</code> by default) and easing linearity factor (3rd
argument of the <a href="http://cubic-bezier.com/#0,0,.5,1">cubic bezier curve</a>,
<code>0.5</code> by default).</p>
</td>
</tr>
<tr id='posanimation-stop'>
<td><code><b>stop</b>()</nobr></code></td>
<td><code></code></td>
<td><p>Stops the animation (if currently running).</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='posanimation-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='posanimation-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='posanimation-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='posanimation-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='posanimation-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='posanimation-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='posanimation-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='posanimation-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='posanimation-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='posanimation-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='posanimation-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='posanimation-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='posanimation-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='posanimation-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='posanimation-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='posanimation-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='draggable'>Draggable</h2><p>A class for making DOM elements draggable (including touch support).
Used internally for map and marker dragging. Only works for elements
that were positioned with <a href="#domutil-setposition"><code>L.DomUtil.setPosition</code></a>.</p>
<section>
<h3 id='draggable-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var draggable = new L.Draggable(elementToDrag);
draggable.enable();
</code></pre>
</section>
</section><section>
<h3 id='draggable-constructor'>Constructor</h3>
<section >
<table><thead>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='draggable-l-draggable'>
<td><code><b>L.Draggable</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><HTMLElement></nobr> <i>dragHandle?</i>, <nobr><Boolean></nobr> <i>preventOutline?</i>, <nobr><<a href='#draggable-option'>Draggable options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td>Creates a <a href="#draggable"><code>Draggable</code></a> object for moving <code>el</code> when you start dragging the <code>dragHandle</code> element (equals <code>el</code> itself by default).</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='draggable-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='draggable-clicktolerance'>
<td><code><b>clickTolerance</b></code></td>
<td><code>Number</code>
<td><code>3</code></td>
<td>The max number of pixels a user can shift the mouse pointer during a click
for it to be considered a valid click (as opposed to a mouse drag).</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='draggable-event'>Events</h3>
<section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='draggable-down'>
<td><code><b>down</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when a drag is about to start.</td>
</tr>
<tr id='draggable-dragstart'>
<td><code><b>dragstart</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when a drag starts</td>
</tr>
<tr id='draggable-predrag'>
<td><code><b>predrag</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired continuously during dragging <em>before</em> each corresponding
update of the element's position.</td>
</tr>
<tr id='draggable-drag'>
<td><code><b>drag</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired continuously during dragging.</td>
</tr>
<tr id='draggable-dragend'>
<td><code><b>dragend</b>
<td><code><a href='#dragendevent'>DragEndEvent</a></code></td>
<td>Fired when the drag ends.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='draggable-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='draggable-enable'>
<td><code><b>enable</b>()</nobr></code></td>
<td><code></code></td>
<td><p>Enables the dragging ability</p>
</td>
</tr>
<tr id='draggable-disable'>
<td><code><b>disable</b>()</nobr></code></td>
<td><code></code></td>
<td><p>Disables the dragging ability</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='draggable-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='draggable-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='draggable-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='draggable-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='draggable-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='draggable-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='draggable-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='draggable-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='draggable-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='draggable-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='draggable-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='draggable-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='draggable-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='draggable-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='draggable-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='draggable-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='class'>Class</h2><p>L.Class powers the OOP facilities of Leaflet and is used to create almost all of the Leaflet classes documented here.
In addition to implementing a simple classical inheritance model, it introduces several special properties for convenient code organization — options, includes and statics.</p>
<section>
<h3 id='class-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var MyClass = L.Class.extend({
initialize: function (greeter) {
this.greeter = greeter;
// class constructor
},
greet: function (name) {
alert(this.greeter + ', ' + name)
}
});
// create instance of MyClass, passing "Hello" to the constructor
var a = new MyClass("Hello");
// call greet method, alerting "Hello, World"
a.greet("World");
</code></pre>
</section><section >
<h4 id='class-class-factories'>Class Factories</h4>
<p>You may have noticed that Leaflet objects are created without using
the <code>new</code> keyword. This is achieved by complementing each class with a
lowercase factory method:</p>
<pre><code class="lang-js">new L.Map('map'); // becomes:
L.map('map');
</code></pre>
<p>The factories are implemented very easily, and you can do this for your own classes:</p>
<pre><code class="lang-js">L.map = function (id, options) {
return new L.Map(id, options);
};
</code></pre>
</section><section >
<h4 id='class-inheritance'>Inheritance</h4>
<p>You use L.Class.extend to define new classes, but you can use the same method on any class to inherit from it:</p>
<pre><code class="lang-js">var MyChildClass = MyClass.extend({
// ... new properties and methods
});
</code></pre>
<p>This will create a class that inherits all methods and properties of the parent class (through a proper prototype chain), adding or overriding the ones you pass to extend. It will also properly react to instanceof:</p>
<pre><code class="lang-js">var a = new MyChildClass();
a instanceof MyChildClass; // true
a instanceof MyClass; // true
</code></pre>
<p>You can call parent methods (including constructor) from corresponding child ones (as you do with super calls in other languages) by accessing parent class prototype and using JavaScript's call or apply:</p>
<pre><code>var MyChildClass = MyClass.extend({
initialize: function () {
MyClass.prototype.initialize.call(this, "Yo");
},
greet: function (name) {
MyClass.prototype.greet.call(this, 'bro ' + name + '!');
}
});
var a = new MyChildClass();
a.greet('Jason'); // alerts "Yo, bro Jason!"
</code></pre>
</section><section >
<h4 id='class-options'>Options</h4>
<p><code>options</code> is a special property that unlike other objects that you pass
to <code>extend</code> will be merged with the parent one instead of overriding it
completely, which makes managing configuration of objects and default
values convenient:</p>
<pre><code class="lang-js">var MyClass = L.Class.extend({
options: {
myOption1: 'foo',
myOption2: 'bar'
}
});
var MyChildClass = MyClass.extend({
options: {
myOption1: 'baz',
myOption3: 5
}
});
var a = new MyChildClass();
a.options.myOption1; // 'baz'
a.options.myOption2; // 'bar'
a.options.myOption3; // 5
</code></pre>
<p>There's also <a href="#util-setoptions"><code>L.Util.setOptions</code></a>, a method for
conveniently merging options passed to constructor with the defaults
defines in the class:</p>
<pre><code class="lang-js">var MyClass = L.Class.extend({
options: {
foo: 'bar',
bla: 5
},
initialize: function (options) {
L.Util.setOptions(this, options);
...
}
});
var a = new MyClass({bla: 10});
a.options; // {foo: 'bar', bla: 10}
</code></pre>
</section><section >
<h4 id='class-includes'>Includes</h4>
<p><code>includes</code> is a special class property that merges all specified objects into the class (such objects are called mixins).</p>
<pre><code class="lang-js"> var MyMixin = {
foo: function () { ... },
bar: 5
};
var MyClass = L.Class.extend({
includes: MyMixin
});
var a = new MyClass();
a.foo();
</code></pre>
<p>You can also do such includes in runtime with the <code>include</code> method:</p>
<pre><code class="lang-js">MyClass.include(MyMixin);
</code></pre>
<p><code>statics</code> is just a convenience property that injects specified object properties as the static properties of the class, useful for defining constants:</p>
<pre><code class="lang-js">var MyClass = L.Class.extend({
statics: {
FOO: 'bar',
BLA: 5
}
});
MyClass.FOO; // 'bar'
</code></pre>
</section><section >
<h4 id='class-constructor-hooks'>Constructor hooks</h4>
<p>If you're a plugin developer, you often need to add additional initialization code to existing classes (e.g. editing hooks for <a href="#polyline"><code>L.Polyline</code></a>). Leaflet comes with a way to do it easily using the <code>addInitHook</code> method:</p>
<pre><code class="lang-js">MyClass.addInitHook(function () {
// ... do something in constructor additionally
// e.g. add event listeners, set custom properties etc.
});
</code></pre>
<p>You can also use the following shortcut when you just need to make one additional method call:</p>
<pre><code class="lang-js">MyClass.addInitHook('methodName', arg1, arg2, …);
</code></pre>
</section>
</section><section>
<h3 id='class-function'>Functions</h3>
<section >
<table><thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='class-extend'>
<td><code><b>extend</b>(<nobr><Object></nobr> <i>props</i>)</nobr></code></td>
<td><code>Function</code></td>
<td><a href="#class-inheritance">Extends the current class</a> given the properties to be included.
Returns a Javascript function that is a class constructor (to be called with <code>new</code>).</td>
</tr>
<tr id='class-include'>
<td><code><b>include</b>(<nobr><Object></nobr> <i>properties</i>)</nobr></code></td>
<td><code>this</code></td>
<td><a href="#class-includes">Includes a mixin</a> into the current class.</td>
</tr>
<tr id='class-mergeoptions'>
<td><code><b>mergeOptions</b>(<nobr><Object></nobr> <i>options</i>)</nobr></code></td>
<td><code>this</code></td>
<td><a href="#class-options">Merges <code>options</code></a> into the defaults of the class.</td>
</tr>
<tr id='class-addinithook'>
<td><code><b>addInitHook</b>(<nobr><Function></nobr> <i>fn</i>)</nobr></code></td>
<td><code>this</code></td>
<td>Adds a <a href="#class-constructor-hooks">constructor hook</a> to the class.</td>
</tr>
</tbody></table>
</section>
</section><h2 id='evented'>Evented</h2><p>A set of methods shared between event-powered classes (like <a href="#map"><code>Map</code></a> and <a href="#marker"><code>Marker</code></a>). Generally, events allow you to execute some function when something happens with an object (e.g. the user clicks on the map, causing the map to fire <code>'click'</code> event).</p>
<section>
<h3 id='evented-example'>Usage example</h3>
<section >
<pre><code class="lang-js">map.on('click', function(e) {
alert(e.latlng);
} );
</code></pre>
<p>Leaflet deals with event listeners by reference, so if you want to add a listener and then remove it, define it as a function:</p>
<pre><code class="lang-js">function onClick(e) { ... }
map.on('click', onClick);
map.off('click', onClick);
</code></pre>
</section>
</section><section>
<h3 id='evented-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='evented-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='evented-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='evented-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='evented-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='evented-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='evented-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='evented-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='evented-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='evented-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='evented-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='evented-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='evented-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='evented-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='evented-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='evented-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='evented-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section>
</section><h2 id='layer'>Layer</h2><p>A set of methods from the Layer base class that all Leaflet layers use.
Inherits all methods, options and events from <a href="#evented"><code>L.Evented</code></a>.</p>
<section>
<h3 id='layer-example'>Usage example</h3>
<section >
<pre><code class="lang-js">var layer = L.Marker(latlng).addTo(map);
layer.addTo(map);
layer.remove();
</code></pre>
</section>
</section><section>
<h3 id='layer-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layer-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='layer-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='layer-event'>Events</h3>
<section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layer-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='layer-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='layer-popup-events'>Popup events</h4>
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layer-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='layer-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='layer-tooltip-events'>Tooltip events</h4>
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layer-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='layer-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='layer-method'>Methods</h3>
<section >
<div class='section-comments'>Classes extending <a href="#layer"><code>L.Layer</code></a> will inherit the following methods:</div>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layer-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='layer-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='layer-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='layer-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='layer-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='layer-extension-methods'>Extension methods</h4>
<div class='section-comments'>Every layer should extend from <a href="#layer"><code>L.Layer</code></a> and (re-)implement the following methods.</div>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layer-onadd'>
<td><code><b>onAdd</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Should contain code that creates DOM elements for the layer, adds them to <code>map panes</code> where they should belong and puts listeners on relevant map events. Called on <a href="#map-addlayer"><code>map.addLayer(layer)</code></a>.</p>
</td>
</tr>
<tr id='layer-onremove'>
<td><code><b>onRemove</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Should contain all clean up code that removes the layer's elements from the DOM and removes listeners previously added in <a href="#layer-onadd"><code>onAdd</code></a>. Called on <a href="#map-removelayer"><code>map.removeLayer(layer)</code></a>.</p>
</td>
</tr>
<tr id='layer-getevents'>
<td><code><b>getEvents</b>()</nobr></code></td>
<td><code>Object</code></td>
<td><p>This optional method should return an object like <code>{ viewreset: this._reset }</code> for <a href="#evented-addeventlistener"><code>addEventListener</code></a>. The event handlers in this object will be automatically added and removed from the map with your layer.</p>
</td>
</tr>
<tr id='layer-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>This optional method should return a string containing HTML to be shown on the <code>Attribution control</code> whenever the layer is visible.</p>
</td>
</tr>
<tr id='layer-beforeadd'>
<td><code><b>beforeAdd</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Optional method. Called on <a href="#map-addlayer"><code>map.addLayer(layer)</code></a>, before the layer is added to the map, before events are initialized, without waiting until the map is in a usable state. Use for early initialization only.</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='layer-popup-methods'>Popup methods</h4>
<div class='section-comments'>All layers share a set of methods convenient for binding popups to it.
<pre><code class="lang-js">var layer = L.Polygon(latlngs).bindPopup('Hi There!').addTo(map);
layer.openPopup();
layer.closePopup();
</code></pre>
<p>Popups will also be automatically opened when the layer is clicked on and closed when the layer is removed from the map or another popup is opened.</p></div>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layer-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='layer-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='layer-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='layer-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='layer-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='layer-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='layer-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='layer-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='layer-tooltip-methods'>Tooltip methods</h4>
<div class='section-comments'>All layers share a set of methods convenient for binding tooltips to it.
<pre><code class="lang-js">var layer = L.Polygon(latlngs).bindTooltip('Hi There!').addTo(map);
layer.openTooltip();
layer.closeTooltip();
</code></pre></div>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layer-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='layer-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='layer-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='layer-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='layer-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='layer-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='layer-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='layer-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layer-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='layer-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='layer-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='layer-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='layer-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='layer-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='layer-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='layer-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='layer-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='layer-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='layer-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='layer-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='layer-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='layer-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='layer-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='layer-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='interactive-layer'>Interactive layer</h2><p>Some <a href="#layer"><code>Layer</code></a>s can be made interactive - when the user interacts
with such a layer, mouse events like <code>click</code> and <code>mouseover</code> can be handled.
Use the <a href="#evented-method">event handling methods</a> to handle these events.</p>
<section>
<h3 id='interactive-layer-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='interactive-layer-interactive'>
<td><code><b>interactive</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>If <code>false</code>, the layer will not emit mouse events and will act as a part of the underlying map.</td>
</tr>
<tr id='interactive-layer-bubblingmouseevents'>
<td><code><b>bubblingMouseEvents</b></code></td>
<td><code>Boolean</code>
<td><code>true</code></td>
<td>When <code>true</code>, a mouse event on this layer will trigger the same event on the map
(unless <a href="#domevent-stoppropagation"><code>L.DomEvent.stopPropagation</code></a> is used).</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='interactive-layer-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='interactive-layer-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='interactive-layer-event'>Events</h3>
<section class='collapsable'>
<h4 id='interactive-layer-mouse-events'>Mouse events</h4>
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='interactive-layer-click'>
<td><code><b>click</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user clicks (or taps) the layer.</td>
</tr>
<tr id='interactive-layer-dblclick'>
<td><code><b>dblclick</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user double-clicks (or double-taps) the layer.</td>
</tr>
<tr id='interactive-layer-mousedown'>
<td><code><b>mousedown</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user pushes the mouse button on the layer.</td>
</tr>
<tr id='interactive-layer-mouseover'>
<td><code><b>mouseover</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse enters the layer.</td>
</tr>
<tr id='interactive-layer-mouseout'>
<td><code><b>mouseout</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the mouse leaves the layer.</td>
</tr>
<tr id='interactive-layer-contextmenu'>
<td><code><b>contextmenu</b>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>Fired when the user right-clicks on the layer, prevents
default browser context menu from showing if there are listeners on
this event. Also fired on mobile when the user holds a single touch
for a second (also called long press).</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='interactive-layer-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='interactive-layer-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='interactive-layer-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='interactive-layer-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='interactive-layer-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='interactive-layer-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Methods</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='interactive-layer-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='interactive-layer-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='interactive-layer-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='interactive-layer-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='interactive-layer-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='interactive-layer-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='interactive-layer-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='interactive-layer-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='interactive-layer-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='interactive-layer-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='interactive-layer-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='interactive-layer-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='interactive-layer-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='interactive-layer-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='interactive-layer-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='interactive-layer-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='interactive-layer-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='interactive-layer-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='interactive-layer-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='interactive-layer-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='interactive-layer-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='interactive-layer-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='interactive-layer-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='interactive-layer-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='interactive-layer-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='interactive-layer-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='interactive-layer-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='interactive-layer-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='interactive-layer-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='interactive-layer-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='interactive-layer-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='interactive-layer-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='interactive-layer-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='interactive-layer-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='interactive-layer-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='interactive-layer-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='interactive-layer-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='control'>Control</h2><p>L.Control is a base class for implementing map controls. Handles positioning.
All other controls extend from this class.</p>
<section>
<h3 id='control-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-position'>
<td><code><b>position</b></code></td>
<td><code>String</code>
<td><code>'topright'</code></td>
<td>The position of the control (one of the map corners). Possible values are <code>'topleft'</code>,
<code>'topright'</code>, <code>'bottomleft'</code> or <code>'bottomright'</code></td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='control-method'>Methods</h3>
<section >
<div class='section-comments'>Classes extending L.Control will inherit the following methods:</div>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-getposition'>
<td><code><b>getPosition</b>()</nobr></code></td>
<td><code>string</code></td>
<td><p>Returns the position of the control.</p>
</td>
</tr>
<tr id='control-setposition'>
<td><code><b>setPosition</b>(<nobr><string></nobr> <i>position</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the position of the control.</p>
</td>
</tr>
<tr id='control-getcontainer'>
<td><code><b>getContainer</b>()</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the HTMLElement that contains the control.</p>
</td>
</tr>
<tr id='control-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the control to the given map.</p>
</td>
</tr>
<tr id='control-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the control from the map it is currently active on.</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='control-extension-methods'>Extension methods</h4>
<div class='section-comments'>Every control should extend from <a href="#control"><code>L.Control</code></a> and (re-)implement the following methods.</div>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='control-onadd'>
<td><code><b>onAdd</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Should return the container DOM element for the control and add listeners on relevant map events. Called on <a href="#control-addTo"><code>control.addTo(map)</code></a>.</p>
</td>
</tr>
<tr id='control-onremove'>
<td><code><b>onRemove</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code></code></td>
<td><p>Optional method. Should contain all clean up code that removes the listeners previously added in <a href="#control-onadd"><code>onAdd</code></a>. Called on <a href="#control-remove"><code>control.remove()</code></a>.</p>
</td>
</tr>
</tbody></table>
</section>
</section><h2 id='handler'>Handler</h2><p>Abstract class for map interaction handlers</p>
<section>
<h3 id='handler-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='handler-enable'>
<td><code><b>enable</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Enables the handler</p>
</td>
</tr>
<tr id='handler-disable'>
<td><code><b>disable</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Disables the handler</p>
</td>
</tr>
<tr id='handler-enabled'>
<td><code><b>enabled</b>()</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if the handler is enabled</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='handler-extension-methods'>Extension methods</h4>
<div class='section-comments'>Classes inheriting from <a href="#handler"><code>Handler</code></a> must implement the two following methods:</div>
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='handler-addhooks'>
<td><code><b>addHooks</b>()</nobr></code></td>
<td><code></code></td>
<td><p>Called when the handler is enabled, should add event hooks.</p>
</td>
</tr>
<tr id='handler-removehooks'>
<td><code><b>removeHooks</b>()</nobr></code></td>
<td><code></code></td>
<td><p>Called when the handler is disabled, should remove the event hooks added previously.</p>
</td>
</tr>
</tbody></table>
</section>
</section><h2 id='projection'>Projection</h2><p>An object with methods for projecting geographical coordinates of the world onto
a flat surface (and back). See <a href="http://en.wikipedia.org/wiki/Map_projection">Map projection</a>.</p>
<section>
<h3 id='projection-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='projection-project'>
<td><code><b>project</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Projects geographical coordinates into a 2D point.
Only accepts actual <a href="#latlng"><code>L.LatLng</code></a> instances, not arrays.</p>
</td>
</tr>
<tr id='projection-unproject'>
<td><code><b>unproject</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>point</i>)</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>The inverse of <code>project</code>. Projects a 2D point into a geographical location.
Only accepts actual <a href="#point"><code>L.Point</code></a> instances, not arrays.</p>
</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='projection-property'>Properties</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='projection-bounds'>
<td><code><b>bounds</b>
<td><code><a href='#bounds'>Bounds</a></code></td>
<td>The bounds (specified in CRS units) where the projection is valid</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='projection-projection'>Defined projections</h3>
<section >
<div class='section-comments'>Leaflet comes with a set of already defined Projections out of the box:</div>
<table><thead>
<tr>
<th>Projection</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='projection-l-projection-lonlat'>
<td><code><b>L.Projection.LonLat</b></code></td>
<td>Equirectangular, or Plate Carree projection — the most simple projection,
mostly used by GIS enthusiasts. Directly maps <code>x</code> as longitude, and <code>y</code> as
latitude. Also suitable for flat worlds, e.g. game maps. Used by the
<code>EPSG:4326</code> and <code>Simple</code> CRS.</td>
</tr>
<tr id='projection-l-projection-mercator'>
<td><code><b>L.Projection.Mercator</b></code></td>
<td>Elliptical Mercator projection — more complex than Spherical Mercator. Takes into account that Earth is a geoid, not a perfect sphere. Used by the EPSG:3395 CRS.</td>
</tr>
<tr id='projection-l-projection-sphericalmercator'>
<td><code><b>L.Projection.SphericalMercator</b></code></td>
<td>Spherical Mercator projection — the most common projection for online maps,
used by almost all free and commercial tile providers. Assumes that Earth is
a sphere. Used by the <code>EPSG:3857</code> CRS.</td>
</tr>
</tbody></table>
</section>
</section><h2 id='crs'>CRS</h2>
<section>
<h3 id='crs-method'>Methods</h3>
<section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='crs-latlngtopoint'>
<td><code><b>latLngToPoint</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><Number></nobr> <i>zoom</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Projects geographical coordinates into pixel coordinates for a given zoom.</p>
</td>
</tr>
<tr id='crs-pointtolatlng'>
<td><code><b>pointToLatLng</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>point</i>, <nobr><Number></nobr> <i>zoom</i>)</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>The inverse of <code>latLngToPoint</code>. Projects pixel coordinates on a given
zoom into geographical coordinates.</p>
</td>
</tr>
<tr id='crs-project'>
<td><code><b>project</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code><a href='#point'>Point</a></code></td>
<td><p>Projects geographical coordinates into coordinates in units accepted for
this CRS (e.g. meters for EPSG:3857, for passing it to WMS services).</p>
</td>
</tr>
<tr id='crs-unproject'>
<td><code><b>unproject</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>point</i>)</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Given a projected coordinate returns the corresponding LatLng.
The inverse of <code>project</code>.</p>
</td>
</tr>
<tr id='crs-scale'>
<td><code><b>scale</b>(<nobr><Number></nobr> <i>zoom</i>)</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the scale used when transforming projected coordinates into
pixel coordinates for a particular zoom. For example, it returns
<code>256 * 2^zoom</code> for Mercator-based CRS.</p>
</td>
</tr>
<tr id='crs-zoom'>
<td><code><b>zoom</b>(<nobr><Number></nobr> <i>scale</i>)</nobr></code></td>
<td><code>Number</code></td>
<td><p>Inverse of <code>scale()</code>, returns the zoom level corresponding to a scale
factor of <code>scale</code>.</p>
</td>
</tr>
<tr id='crs-getprojectedbounds'>
<td><code><b>getProjectedBounds</b>(<nobr><Number></nobr> <i>zoom</i>)</nobr></code></td>
<td><code><a href='#bounds'>Bounds</a></code></td>
<td><p>Returns the projection's bounds scaled and transformed for the provided <code>zoom</code>.</p>
</td>
</tr>
<tr id='crs-distance'>
<td><code><b>distance</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng1</i>, <nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng2</i>)</nobr></code></td>
<td><code>Number</code></td>
<td><p>Returns the distance between two geographical coordinates.</p>
</td>
</tr>
<tr id='crs-wraplatlng'>
<td><code><b>wrapLatLng</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>)</nobr></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><p>Returns a <a href="#latlng"><code>LatLng</code></a> where lat and lng has been wrapped according to the
CRS's <code>wrapLat</code> and <code>wrapLng</code> properties, if they are outside the CRS's bounds.</p>
</td>
</tr>
<tr id='crs-wraplatlngbounds'>
<td><code><b>wrapLatLngBounds</b>(<nobr><<a href='#latlngbounds'>LatLngBounds</a>></nobr> <i>bounds</i>)</nobr></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><p>Returns a <a href="#latlngbounds"><code>LatLngBounds</code></a> with the same size as the given one, ensuring
that its center is within the CRS's bounds.
Only accepts actual <a href="#latlngbounds"><code>L.LatLngBounds</code></a> instances, not arrays.</p>
</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='crs-property'>Properties</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='crs-code'>
<td><code><b>code</b>
<td><code>String</code></td>
<td>Standard code name of the CRS passed into WMS services (e.g. <code>'EPSG:3857'</code>)</td>
</tr>
<tr id='crs-wraplng'>
<td><code><b>wrapLng</b>
<td><code>Number[]</code></td>
<td>An array of two numbers defining whether the longitude (horizontal) coordinate
axis wraps around a given range and how. Defaults to <code>[-180, 180]</code> in most
geographical CRSs. If <code>undefined</code>, the longitude axis does not wrap around.</td>
</tr>
<tr id='crs-wraplat'>
<td><code><b>wrapLat</b>
<td><code>Number[]</code></td>
<td>Like <code>wrapLng</code>, but for the latitude (vertical) axis.</td>
</tr>
<tr id='crs-infinite'>
<td><code><b>infinite</b>
<td><code>Boolean</code></td>
<td>If true, the coordinate space will be unbounded (infinite in both axes)</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='crs-crs'>Defined CRSs</h3>
<section >
<table><thead>
<tr>
<th>CRS</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='crs-l-crs-epsg3395'>
<td><code><b>L.CRS.EPSG3395</b></code></td>
<td>Rarely used by some commercial tile providers. Uses Elliptical Mercator projection.</td>
</tr>
<tr id='crs-l-crs-epsg3857'>
<td><code><b>L.CRS.EPSG3857</b></code></td>
<td>The most common CRS for online maps, used by almost all free and commercial
tile providers. Uses Spherical Mercator projection. Set in by default in
Map's <a href="#crs"><code>crs</code></a> option.</td>
</tr>
<tr id='crs-l-crs-epsg4326'>
<td><code><b>L.CRS.EPSG4326</b></code></td>
<td>A common CRS among GIS enthusiasts. Uses simple Equirectangular projection.
Leaflet 1.0.x complies with the <a href="https://wiki.osgeo.org/wiki/Tile_Map_Service_Specification#global-geodetic">TMS coordinate scheme for EPSG:4326</a>,
which is a breaking change from 0.7.x behaviour. If you are using a <a href="#tilelayer"><code>TileLayer</code></a>
with this CRS, ensure that there are two 256x256 pixel tiles covering the
whole earth at zoom level zero, and that the tile coordinate origin is (-180,+90),
or (-180,-90) for <code>TileLayer</code>s with <a href="#tilelayer-tms">the <code>tms</code> option</a> set.</td>
</tr>
<tr id='crs-l-crs-earth'>
<td><code><b>L.CRS.Earth</b></code></td>
<td>Serves as the base for CRS that are global such that they cover the earth.
Can only be used as the base for other CRS and cannot be used directly,
since it does not have a <code>code</code>, <a href="#projection"><code>projection</code></a> or <a href="#transformation"><code>transformation</code></a>. <code>distance()</code> returns
meters.</td>
</tr>
<tr id='crs-l-crs-simple'>
<td><code><b>L.CRS.Simple</b></code></td>
<td>A simple CRS that maps longitude and latitude into <code>x</code> and <code>y</code> directly.
May be used for maps of flat surfaces (e.g. game maps). Note that the <code>y</code>
axis should still be inverted (going from bottom to top). <code>distance()</code> returns
simple euclidean distance.</td>
</tr>
<tr id='crs-l-crs-base'>
<td><code><b>L.CRS.Base</b></code></td>
<td>Object that defines coordinate reference systems for projecting
geographical points into pixel (screen) coordinates and back (and to
coordinates in other units for <a href="https://en.wikipedia.org/wiki/Web_Map_Service">WMS</a> services). See
<a href="http://en.wikipedia.org/wiki/Coordinate_reference_system">spatial reference system</a>.
Leaflet defines the most usual CRSs by default. If you want to use a
CRS not defined by default, take a look at the
<a href="https://github.com/kartena/Proj4Leaflet">Proj4Leaflet</a> plugin.</td>
</tr>
</tbody></table>
</section>
</section><h2 id='renderer'>Renderer</h2><p>Base class for vector renderer implementations (<a href="#svg"><code>SVG</code></a>, <a href="#canvas"><code>Canvas</code></a>). Handles the
DOM container of the renderer, its bounds, and its zoom animation.
A <a href="#renderer"><code>Renderer</code></a> works as an implicit layer group for all <a href="#path"><code>Path</code></a>s - the renderer
itself can be added or removed to the map. All paths use a renderer, which can
be implicit (the map will decide the type of renderer and use it automatically)
or explicit (using the <a href="#path-renderer"><a href="#renderer"><code>renderer</code></a></a> option of the path).
Do not use this class directly, use <code>SVG</code> and <code>Canvas</code> instead.</p>
<section>
<h3 id='renderer-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='renderer-padding'>
<td><code><b>padding</b></code></td>
<td><code>Number</code>
<td><code>0.1</code></td>
<td>How much to extend the clip area around the map view (relative to its size)
e.g. 0.1 would be 10% of map view in each direction</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='renderer-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'overlayPane'</code></td>
<td>By default the layer will be added to the map's <a href="#map-overlaypane">overlay pane</a>. Overriding this option will cause the layer to be placed on another pane by default.</td>
</tr>
<tr id='renderer-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id='renderer-event'>Events</h3>
<section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='renderer-update'>
<td><code><b>update</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired when the renderer updates its bounds, center and zoom, for example when
its map has moved</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='renderer-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='renderer-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='renderer-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='renderer-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='renderer-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='renderer-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Methods</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='renderer-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='renderer-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='renderer-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='renderer-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='renderer-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='renderer-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='renderer-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='renderer-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='renderer-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='renderer-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='renderer-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='renderer-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='renderer-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='renderer-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='renderer-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='renderer-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='renderer-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='renderer-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='renderer-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='renderer-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='renderer-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='renderer-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='renderer-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='renderer-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='renderer-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='renderer-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='renderer-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='renderer-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='renderer-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='renderer-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='renderer-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='renderer-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='renderer-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='renderer-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='renderer-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='renderer-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='renderer-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='event-objects'>Event objects</h2><p>Whenever a class inheriting from <a href="#evented"><code>Evented</code></a> fires an event, a listener function
will be called with an event argument, which is a plain object containing
information about the event. For example:</p>
<pre><code class="lang-js">map.on('click', function(ev) {
alert(ev.latlng); // ev is an event object (MouseEvent in this case)
});
</code></pre>
<p>The information available depends on the event type:</p>
<span id='event'></span>
<section>
<h3 id='event-property'>Event</h3>
<section >
<div class='section-comments'>The base event object. All other event objects contain these properties too.</div>
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='event-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='event-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section>
</section><span id='keyboardevent'></span>
<section>
<h3 id='keyboardevent-property'>KeyboardEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='keyboardevent-originalevent'>
<td><code><b>originalEvent</b>
<td><code>DOMEvent</code></td>
<td>The original <a href="https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent">DOM <a href="#keyboardevent"><code>KeyboardEvent</code></a></a> that triggered this Leaflet event.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='keyboardevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='keyboardevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='mouseevent'></span>
<section>
<h3 id='mouseevent-property'>MouseEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='mouseevent-latlng'>
<td><code><b>latlng</b>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td>The geographical point where the mouse event occured.</td>
</tr>
<tr id='mouseevent-layerpoint'>
<td><code><b>layerPoint</b>
<td><code><a href='#point'>Point</a></code></td>
<td>Pixel coordinates of the point where the mouse event occured relative to the map layer.</td>
</tr>
<tr id='mouseevent-containerpoint'>
<td><code><b>containerPoint</b>
<td><code><a href='#point'>Point</a></code></td>
<td>Pixel coordinates of the point where the mouse event occured relative to the map сontainer.</td>
</tr>
<tr id='mouseevent-originalevent'>
<td><code><b>originalEvent</b>
<td><code>DOMEvent</code></td>
<td>The original <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent">DOM <a href="#mouseevent"><code>MouseEvent</code></a></a> or <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent">DOM <code>TouchEvent</code></a> that triggered this Leaflet event.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='mouseevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='mouseevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='locationevent'></span>
<section>
<h3 id='locationevent-property'>LocationEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='locationevent-latlng'>
<td><code><b>latlng</b>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td>Detected geographical location of the user.</td>
</tr>
<tr id='locationevent-bounds'>
<td><code><b>bounds</b>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td>Geographical bounds of the area user is located in (with respect to the accuracy of location).</td>
</tr>
<tr id='locationevent-accuracy'>
<td><code><b>accuracy</b>
<td><code>Number</code></td>
<td>Accuracy of location in meters.</td>
</tr>
<tr id='locationevent-altitude'>
<td><code><b>altitude</b>
<td><code>Number</code></td>
<td>Height of the position above the WGS84 ellipsoid in meters.</td>
</tr>
<tr id='locationevent-altitudeaccuracy'>
<td><code><b>altitudeAccuracy</b>
<td><code>Number</code></td>
<td>Accuracy of altitude in meters.</td>
</tr>
<tr id='locationevent-heading'>
<td><code><b>heading</b>
<td><code>Number</code></td>
<td>The direction of travel in degrees counting clockwise from true North.</td>
</tr>
<tr id='locationevent-speed'>
<td><code><b>speed</b>
<td><code>Number</code></td>
<td>Current velocity in meters per second.</td>
</tr>
<tr id='locationevent-timestamp'>
<td><code><b>timestamp</b>
<td><code>Number</code></td>
<td>The time when the position was acquired.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='locationevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='locationevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='errorevent'></span>
<section>
<h3 id='errorevent-property'>ErrorEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='errorevent-message'>
<td><code><b>message</b>
<td><code>String</code></td>
<td>Error message.</td>
</tr>
<tr id='errorevent-code'>
<td><code><b>code</b>
<td><code>Number</code></td>
<td>Error code (if applicable).</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='errorevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='errorevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='layerevent'></span>
<section>
<h3 id='layerevent-property'>LayerEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layerevent-layer'>
<td><code><b>layer</b>
<td><code><a href='#layer'>Layer</a></code></td>
<td>The layer that was added or removed.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layerevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='layerevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='layerscontrolevent'></span>
<section>
<h3 id='layerscontrolevent-property'>LayersControlEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layerscontrolevent-layer'>
<td><code><b>layer</b>
<td><code><a href='#layer'>Layer</a></code></td>
<td>The layer that was added or removed.</td>
</tr>
<tr id='layerscontrolevent-name'>
<td><code><b>name</b>
<td><code>String</code></td>
<td>The name of the layer that was added or removed.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='layerscontrolevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='layerscontrolevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='tileevent'></span>
<section>
<h3 id='tileevent-property'>TileEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tileevent-tile'>
<td><code><b>tile</b>
<td><code>HTMLElement</code></td>
<td>The tile element (image).</td>
</tr>
<tr id='tileevent-coords'>
<td><code><b>coords</b>
<td><code><a href='#point'>Point</a></code></td>
<td>Point object with the tile's <code>x</code>, <code>y</code>, and <code>z</code> (zoom level) coordinates.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tileevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='tileevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='tileerrorevent'></span>
<section>
<h3 id='tileerrorevent-property'>TileErrorEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tileerrorevent-tile'>
<td><code><b>tile</b>
<td><code>HTMLElement</code></td>
<td>The tile element (image).</td>
</tr>
<tr id='tileerrorevent-coords'>
<td><code><b>coords</b>
<td><code><a href='#point'>Point</a></code></td>
<td>Point object with the tile's <code>x</code>, <code>y</code>, and <code>z</code> (zoom level) coordinates.</td>
</tr>
<tr id='tileerrorevent-error'>
<td><code><b>error</b>
<td><code>*</code></td>
<td>Error passed to the tile's <code>done()</code> callback.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tileerrorevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='tileerrorevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='resizeevent'></span>
<section>
<h3 id='resizeevent-property'>ResizeEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='resizeevent-oldsize'>
<td><code><b>oldSize</b>
<td><code><a href='#point'>Point</a></code></td>
<td>The old size before resize event.</td>
</tr>
<tr id='resizeevent-newsize'>
<td><code><b>newSize</b>
<td><code><a href='#point'>Point</a></code></td>
<td>The new size after the resize event.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='resizeevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='resizeevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='geojsonevent'></span>
<section>
<h3 id='geojsonevent-property'>GeoJSONEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojsonevent-layer'>
<td><code><b>layer</b>
<td><code><a href='#layer'>Layer</a></code></td>
<td>The layer for the GeoJSON feature that is being added to the map.</td>
</tr>
<tr id='geojsonevent-properties'>
<td><code><b>properties</b>
<td><code>Object</code></td>
<td>GeoJSON properties of the feature.</td>
</tr>
<tr id='geojsonevent-geometrytype'>
<td><code><b>geometryType</b>
<td><code>String</code></td>
<td>GeoJSON geometry type of the feature.</td>
</tr>
<tr id='geojsonevent-id'>
<td><code><b>id</b>
<td><code>String</code></td>
<td>GeoJSON ID of the feature (if present).</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='geojsonevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='geojsonevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='popupevent'></span>
<section>
<h3 id='popupevent-property'>PopupEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popupevent-popup'>
<td><code><b>popup</b>
<td><code><a href='#popup'>Popup</a></code></td>
<td>The popup that was opened or closed.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='popupevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='popupevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='tooltipevent'></span>
<section>
<h3 id='tooltipevent-property'>TooltipEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltipevent-tooltip'>
<td><code><b>tooltip</b>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td>The tooltip that was opened or closed.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='tooltipevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='tooltipevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='dragendevent'></span>
<section>
<h3 id='dragendevent-property'>DragEndEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='dragendevent-distance'>
<td><code><b>distance</b>
<td><code>Number</code></td>
<td>The distance in pixels the draggable element was moved by.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='dragendevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='dragendevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><span id='zoomanimevent'></span>
<section>
<h3 id='zoomanimevent-property'>ZoomAnimEvent</h3>
<section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='zoomanimevent-center'>
<td><code><b>center</b>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td>The current center of the map</td>
</tr>
<tr id='zoomanimevent-zoom'>
<td><code><b>zoom</b>
<td><code>Number</code></td>
<td>The current zoom level of the map</td>
</tr>
<tr id='zoomanimevent-noupdate'>
<td><code><b>noUpdate</b>
<td><code>Boolean</code></td>
<td>Whether layers should update their contents due to this event</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Properties inherited from <a href='#event'>Event</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='zoomanimevent-type'>
<td><code><b>type</b>
<td><code>String</code></td>
<td>The event type (e.g. <code>'click'</code>).</td>
</tr>
<tr id='zoomanimevent-target'>
<td><code><b>target</b>
<td><code>Object</code></td>
<td>The object that fired the event.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='divoverlay'>DivOverlay</h2><p>Base model for L.Popup and L.Tooltip. Inherit from it for custom popup like plugins.</p>
<section>
<h3 id='divoverlay-option'>Options</h3>
<section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divoverlay-offset'>
<td><code><b>offset</b></code></td>
<td><code><a href='#point'>Point</a></code>
<td><code>Point(0, 7)</code></td>
<td>The offset of the popup position. Useful to control the anchor
of the popup when opening it on some overlays.</td>
</tr>
<tr id='divoverlay-classname'>
<td><code><b>className</b></code></td>
<td><code>String</code>
<td><code>''</code></td>
<td>A custom CSS class name to assign to the popup.</td>
</tr>
<tr id='divoverlay-pane'>
<td><code><b>pane</b></code></td>
<td><code>String</code>
<td><code>'popupPane'</code></td>
<td><code>Map pane</code> where the popup will be added.</td>
</tr>
</tbody></table>
</section>
<div class='accordion'>
<label><span class='expander'>▶</span> Options inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divoverlay-attribution'>
<td><code><b>attribution</b></code></td>
<td><code>String</code>
<td><code>null</code></td>
<td>String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Events</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divoverlay-add'>
<td><code><b>add</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is added to a map</td>
</tr>
<tr id='divoverlay-remove'>
<td><code><b>remove</b>
<td><code><a href='#event'>Event</a></code></td>
<td>Fired after the layer is removed from a map</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divoverlay-popupopen'>
<td><code><b>popupopen</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is opened</td>
</tr>
<tr id='divoverlay-popupclose'>
<td><code><b>popupclose</b>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>Fired when a popup bound to this layer is closed</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip events inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Event</th>
<th>Data</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divoverlay-tooltipopen'>
<td><code><b>tooltipopen</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is opened.</td>
</tr>
<tr id='divoverlay-tooltipclose'>
<td><code><b>tooltipclose</b>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>Fired when a tooltip bound to this layer is closed.</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><section>
<h3 id=''>Methods</h3>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divoverlay-addto'>
<td><code><b>addTo</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds the layer to the given map</p>
</td>
</tr>
<tr id='divoverlay-remove'>
<td><code><b>remove</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the map it is currently active on.</p>
</td>
</tr>
<tr id='divoverlay-removefrom'>
<td><code><b>removeFrom</b>(<nobr><<a href='#map'>Map</a>></nobr> <i>map</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the layer from the given map</p>
</td>
</tr>
<tr id='divoverlay-getpane'>
<td><code><b>getPane</b>(<nobr><String></nobr> <i>name?</i>)</nobr></code></td>
<td><code>HTMLElement</code></td>
<td><p>Returns the <code>HTMLElement</code> representing the named pane on the map. If <code>name</code> is omitted, returns the pane for this layer.</p>
</td>
</tr>
<tr id='divoverlay-getattribution'>
<td><code><b>getAttribution</b>()</nobr></code></td>
<td><code>String</code></td>
<td><p>Used by the <code>attribution control</code>, returns the <a href="#gridlayer-attribution">attribution option</a>.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Popup methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divoverlay-bindpopup'>
<td><code><b>bindPopup</b>(<nobr><String|HTMLElement|Function|Popup></nobr> <i>content</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a popup to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='divoverlay-unbindpopup'>
<td><code><b>unbindPopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the popup previously bound with <code>bindPopup</code>.</p>
</td>
</tr>
<tr id='divoverlay-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound popup at the specificed <a href="#latlng"><code>latlng</code></a> or at the default popup anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='divoverlay-closepopup'>
<td><code><b>closePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the popup bound to this layer if it is open.</p>
</td>
</tr>
<tr id='divoverlay-togglepopup'>
<td><code><b>togglePopup</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the popup bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='divoverlay-ispopupopen'>
<td><code><b>isPopupOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the popup bound to this layer is currently open.</p>
</td>
</tr>
<tr id='divoverlay-setpopupcontent'>
<td><code><b>setPopupContent</b>(<nobr><String|HTMLElement|Popup></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the popup bound to this layer.</p>
</td>
</tr>
<tr id='divoverlay-getpopup'>
<td><code><b>getPopup</b>()</nobr></code></td>
<td><code><a href='#popup'>Popup</a></code></td>
<td><p>Returns the popup bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Tooltip methods inherited from <a href='#layer'>Layer</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divoverlay-bindtooltip'>
<td><code><b>bindTooltip</b>(<nobr><String|HTMLElement|Function|Tooltip></nobr> <i>content</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Binds a tooltip to the layer with the passed <code>content</code> and sets up the
neccessary event listeners. If a <code>Function</code> is passed it will receive
the layer as the first argument and should return a <code>String</code> or <code>HTMLElement</code>.</p>
</td>
</tr>
<tr id='divoverlay-unbindtooltip'>
<td><code><b>unbindTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes the tooltip previously bound with <code>bindTooltip</code>.</p>
</td>
</tr>
<tr id='divoverlay-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens the bound tooltip at the specificed <a href="#latlng"><code>latlng</code></a> or at the default tooltip anchor if no <code>latlng</code> is passed.</p>
</td>
</tr>
<tr id='divoverlay-closetooltip'>
<td><code><b>closeTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Closes the tooltip bound to this layer if it is open.</p>
</td>
</tr>
<tr id='divoverlay-toggletooltip'>
<td><code><b>toggleTooltip</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Opens or closes the tooltip bound to this layer depending on its current state.</p>
</td>
</tr>
<tr id='divoverlay-istooltipopen'>
<td><code><b>isTooltipOpen</b>()</nobr></code></td>
<td><code>boolean</code></td>
<td><p>Returns <code>true</code> if the tooltip bound to this layer is currently open.</p>
</td>
</tr>
<tr id='divoverlay-settooltipcontent'>
<td><code><b>setTooltipContent</b>(<nobr><String|HTMLElement|Tooltip></nobr> <i>content</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Sets the content of the tooltip bound to this layer.</p>
</td>
</tr>
<tr id='divoverlay-gettooltip'>
<td><code><b>getTooltip</b>()</nobr></code></td>
<td><code><a href='#tooltip'>Tooltip</a></code></td>
<td><p>Returns the tooltip bound to this layer.</p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
<div class='accordion'>
<label><span class='expander'>▶</span> Methods inherited from <a href='#evented'>Evented</a></label>
<div class='accordion-overflow'>
<div class='accordion-content'><section >
<table><thead>
<tr>
<th>Method</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr id='divoverlay-on'>
<td><code><b>on</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. <code>'click dblclick'</code>).</p>
</td>
</tr>
<tr id='divoverlay-on'>
<td><code><b>on</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></p>
</td>
</tr>
<tr id='divoverlay-off'>
<td><code><b>off</b>(<nobr><String></nobr> <i>type</i>, <nobr><Function></nobr> <i>fn?</i>, <nobr><Object></nobr> <i>context?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to <code>on</code>, you must pass the same context to <code>off</code> in order to remove the listener.</p>
</td>
</tr>
<tr id='divoverlay-off'>
<td><code><b>off</b>(<nobr><Object></nobr> <i>eventMap</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes a set of type/listener pairs.</p>
</td>
</tr>
<tr id='divoverlay-off'>
<td><code><b>off</b>()</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes all listeners to all events on the object.</p>
</td>
</tr>
<tr id='divoverlay-fire'>
<td><code><b>fire</b>(<nobr><String></nobr> <i>type</i>, <nobr><Object></nobr> <i>data?</i>, <nobr><Boolean></nobr> <i>propagate?</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Fires an event of the specified type. You can optionally provide an data
object — the first argument of the listener function will contain its
properties. The event can optionally be propagated to event parents.</p>
</td>
</tr>
<tr id='divoverlay-listens'>
<td><code><b>listens</b>(<nobr><String></nobr> <i>type</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Returns <code>true</code> if a particular event type has any listeners attached to it.</p>
</td>
</tr>
<tr id='divoverlay-once'>
<td><code><b>once</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Behaves as <a href="#evented-on"><code>on(…)</code></a>, except the listener will only get fired once and then removed.</p>
</td>
</tr>
<tr id='divoverlay-addeventparent'>
<td><code><b>addEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Adds an event parent - an <a href="#evented"><code>Evented</code></a> that will receive propagated events</p>
</td>
</tr>
<tr id='divoverlay-removeeventparent'>
<td><code><b>removeEventParent</b>(<nobr><<a href='#evented'>Evented</a>></nobr> <i>obj</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Removes an event parent, so it will stop receiving propagated events</p>
</td>
</tr>
<tr id='divoverlay-addeventlistener'>
<td><code><b>addEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-on"><code>on(…)</code></a></p>
</td>
</tr>
<tr id='divoverlay-removeeventlistener'>
<td><code><b>removeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off(…)</code></a></p>
</td>
</tr>
<tr id='divoverlay-clearalleventlisteners'>
<td><code><b>clearAllEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-off"><code>off()</code></a></p>
</td>
</tr>
<tr id='divoverlay-addonetimeeventlistener'>
<td><code><b>addOneTimeEventListener</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-once"><code>once(…)</code></a></p>
</td>
</tr>
<tr id='divoverlay-fireevent'>
<td><code><b>fireEvent</b>(<i>…</i>)</nobr></code></td>
<td><code>this</code></td>
<td><p>Alias to <a href="#evented-fire"><code>fire(…)</code></a></p>
</td>
</tr>
<tr id='divoverlay-haseventlisteners'>
<td><code><b>hasEventListeners</b>(<i>…</i>)</nobr></code></td>
<td><code>Boolean</code></td>
<td><p>Alias to <a href="#evented-listens"><code>listens(…)</code></a></p>
</td>
</tr>
</tbody></table>
</section></div>
</div>
</div>
</section><h2 id='global-switches'>Global Switches</h2><p>Global switches are created for rare cases and generally make
Leaflet to not detect a particular browser feature even if it's
there. You need to set the switch as a global variable to true
before including Leaflet on the page, like this:</p>
<pre><code class="lang-html"><script>L_NO_TOUCH = true;</script>
<script src="leaflet.js"></script>
</code></pre>
<table>
<thead>
<tr>
<th>Switch</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>L_NO_TOUCH</code></td>
<td>Forces Leaflet to not use touch events even if it detects them.</td>
</tr>
<tr>
<td><code>L_DISABLE_3D</code></td>
<td>Forces Leaflet to not use hardware-accelerated CSS 3D transforms for positioning (which may cause glitches in some rare environments) even if they're supported.</td>
</tr>
</tbody>
</table>
<h2 id='noconflict'>noConflict</h2><p>This method restores the <code>L</code> global variable to the original value
it had before Leaflet inclusion, and returns the real Leaflet
namespace so you can put it elsewhere, like this:</p>
<pre><code class="lang-html"><script src='libs/l.js'>
<!-- L points to some other library -->
<script src='leaflet.js'>
<!-- you include Leaflet, it replaces the L variable to Leaflet namespace -->
<script>
var Leaflet = L.noConflict();
// now L points to that other library again, and you can use Leaflet.Map etc.
</script>
</code></pre>
<h2 id='version'>version</h2><p>A constant that represents the Leaflet version in use.</p>
<pre><code class="lang-js">L.version; // contains "1.0.0" (or whatever version is currently in use)
</code></pre>
<div class="footer">
<p>© 2017 <a href="http://agafonkin.com/en">Vladimir Agafonkin</a>. Maps © <a href="http://openstreetmap.org/copyright">OpenStreetMap</a> contributors.</p>
</div>
</div>
<script src="http://leafletjs.com/docs/js/docs.js"></script>
<script>
hljs.configure({tabReplace: ' '});
hljs.initHighlightingOnLoad();
var elems = document.querySelectorAll('h2, h3, h4, tr');
for (var i = 0, len = elems.length; i < len; i++) {
var el = elems[i];
if (el.id) {
var anchor = document.createElement('a');
anchor.setAttribute('anchor', el.id);
if (!el.children.length) {
// For headers, insert the anchor before.
el.parentNode.insertBefore(anchor, el);
} else {
// For table rows, insert the anchor inside the first <td>
el.querySelector('td').appendChild(anchor);
// Clicking on the row (meaning "the link icon on the ::before)
// jumps to the item
el.parentNode.onclick = function(hash){
return function(ev) {
if (ev.offsetX < 0) {
window.location.hash = '#' + ev.target.parentNode.id;
}
};
}(el.id);
}
}
}
elems = document.querySelectorAll('div.accordion');
for (var i = 0, len = elems.length; i < len; i++) {
var el = elems[i];
el.querySelector('label').addEventListener('click', function(c){
return function() {
if (c.className === 'accordion expanded') {
c.className = 'accordion collapsed';
} else {
c.className = 'accordion expanded';
}
};
}(el));
// el.className = 'accordion collapsed';
// el.querySelector('.accordion-content').style.display = 'none';
}
</script>
<style>
h2 {
margin-top: 2em;
}
h3 {
margin-top: 1em;
margin-bottom: .5em;
}
div.accordion {
width: 100%;
/* overflow: hidden; */
}
div.accordion-overflow {
width: 100%;
overflow: hidden;
}
label,
section > h4 {
display: block;
font-weight: 500;
margin: 1em 0 0.25em;
}
label {
cursor: pointer;
}
div.accordion > div.accordion-overflow > div.accordion-content {
max-height: 0;
display: none;
}
div.accordion.collapsed > div.accordion-overflow > div.accordion-content {
animation-duration: 0.4s;
animation-name: collapse;
/* height: 0; */
max-height: 0;
display: block;
overflow: hidden;
}
div.accordion.expanded > div.accordion-overflow > div.accordion-content {
animation-duration: 0.4s;
animation-name: expand;
/* height: auto; */
max-height: none;
display: block;
}
@keyframes collapse {
0% { max-height: 100vh; }
100% { max-height: 0; }
}
@keyframes expand {
0% { max-height: 0; }
100% { max-height: 100vh; }
}
/* div.accordion > div.accordion-content {
transition: max-height 0.4s ease-out 0s;
}*/
div.accordion.expanded > label > span.expander {
transform: rotate(90deg);
}
div.accordion > label > span.expander {
transition: transform 0.4s ease-out 0s;
display: inline-block;
font-size: 12px;
}
table {
margin-bottom: 0;
}
/* Markdown renders some spurious <p>s inside the table cells */
td > p {
margin:0;
}
/* This just looks bad (with the current grey headers for sections which Vlad doesn't really like, so might have to change this) */
section.collapsable > div.section-comments > p {
margin:0;
}
div.section-comments {
margin-bottom: 0.25em;
}
/* section.collapsable div.section-comments {
margin: 1em;
font-size: 12px;
}*/
section.collapsable pre {
margin:0;
}
section {
margin-left: 0.5em;
}
section h4, section.collapsable h4 {
margin-left: -0.5em;
}
</style>
</body></html>
|
watari53/HighWayStampRally
|
www/components/Leaflet/docs/reference-1.1.0.html
|
HTML
|
mit
| 763,149 |
<!DOCTYPE html>
<html>
<head>
<title></title>
<link href="//fonts.googleapis.com/css?family=Ubuntu+Mono" rel="stylesheet" type="text/css">
<link rel="stylesheet" type="text/css" href="styles/screen.css">
</head>
<body>
<script src="scripts/eventTarget.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/three.js/r71/three.js"></script>
<script>window.THREE || document.write('<script src="../node_modules/three/three.js"><\/script>')</script>
<script src="scripts/OrbitControls.js"></script>
<script src="scripts/ThreeCSG.js"></script>
<script src="scripts/gameLoop.js"></script>
<script src="scripts/threeBase.js"></script>
<script src="scripts/sketch.js"></script>
<script src="scripts/main.js"></script>
</body>
</html>
|
doathousandmore/atm_0004
|
dist/6-4-2015_9-58-16/index.html
|
HTML
|
mit
| 765 |
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<link rel="shortcut icon" type="image/ico" href="http://www.datatables.net/favicon.ico">
<meta name="viewport" content="initial-scale=1.0, maximum-scale=2.0">
<title>DataTables example - Deferred loading of data</title>
<link rel="stylesheet" type="text/css" href="../../media/css/jquery.dataTables.css">
<link rel="stylesheet" type="text/css" href="../resources/syntax/shCore.css">
<link rel="stylesheet" type="text/css" href="../resources/demo.css">
<style type="text/css" class="init">
</style>
<script type="text/javascript" language="javascript" src="../../media/js/jquery.js"></script>
<script type="text/javascript" language="javascript" src="../../media/js/jquery.dataTables.js"></script>
<script type="text/javascript" language="javascript" src="../resources/syntax/shCore.js"></script>
<script type="text/javascript" language="javascript" src="../resources/demo.js"></script>
<script type="text/javascript" language="javascript" class="init">
$(document).ready(function() {
$('#example').dataTable( {
"processing": true,
"serverSide": true,
"ajax": "scripts/server_processing.php",
"deferLoading": 57
} );
} );
</script>
</head>
<body class="dt-example">
<div class="container">
<section>
<h1>DataTables example <span>Deferred loading of data</span></h1>
<div class="info">
<p>When using DataTables with server-side processing, the default behaviour is to have DataTables
automatically make an Ajax call and load the data, removing anything which might have already been in
the table. However, this behaviour might not always be desirable when the first page of the table has
already been preloaded in the HTML (which you might do to ensure accessibility or for performance
reasons).</p>
<p>This automatic Ajax call to get the first page of data can be overridden by using the <a href=
"//datatables.net/reference/option/deferLoading"><code class="option" title=
"DataTables initialisation option">deferLoading<span>DT</span></code></a> initialisation property. It
serves two purposes, firstly to indicate that deferred loading is required, but also to tell DataTables
how many records there are in the full table, in this case 57 (this allows the information element and
pagination to be displayed correctly).</p>
<p>In the example below, the HTML page already has the first 10 rows of data available it in, so we use
<a href="//datatables.net/reference/option/deferLoading"><code class="option" title=
"DataTables initialisation option">deferLoading<span>DT</span></code></a> to tell DataTables that this
data is available and that it should wait for under interaction (ordering, paging etc) before making an
Ajax call.</p>
</div>"
<table id="example" class="display" cellspacing="0" width="100%">
<thead>
<tr>
<th>First name</th>
<th>Last name</th>
<th>Position</th>
<th>Office</th>
<th>Start date</th>
<th>Salary</th>
</tr>
</thead>
<tfoot>
<tr>
<th>First name</th>
<th>Last name</th>
<th>Position</th>
<th>Office</th>
<th>Start date</th>
<th>Salary</th>
</tr>
</tfoot>
<tr class="odd">
<td class="sorting_1">Airi Satou</td>
<td>Accountant</td>
<td>Tokyo</td>
<td>33</td>
<td>2008/11/28</td>
<td>$162,700</td>
</tr>
<tr class="even">
<td class="sorting_1">Angelica Ramos</td>
<td>Chief Executive Officer (CEO)</td>
<td>London</td>
<td>47</td>
<td>2009/10/09</td>
<td>$1,200,000</td>
</tr>
<tr class="odd">
<td class="sorting_1">Ashton Cox</td>
<td>Junior Technical Author</td>
<td>San Francisco</td>
<td>66</td>
<td>2009/01/12</td>
<td>$86,000</td>
</tr>
<tr class="even">
<td class="sorting_1">Bradley Greer</td>
<td>Software Engineer</td>
<td>London</td>
<td>41</td>
<td>2012/10/13</td>
<td>$132,000</td>
</tr>
<tr class="odd">
<td class="sorting_1">Brenden Wagner</td>
<td>Software Engineer</td>
<td>San Francisco</td>
<td>28</td>
<td>2011/06/07</td>
<td>$206,850</td>
</tr>
<tr class="even">
<td class="sorting_1">Brielle Williamson</td>
<td>Integration Specialist</td>
<td>New York</td>
<td>61</td>
<td>2012/12/02</td>
<td>$372,000</td>
</tr>
<tr class="odd">
<td class="sorting_1">Bruno Nash</td>
<td>Software Engineer</td>
<td>London</td>
<td>38</td>
<td>2011/05/03</td>
<td>$163,500</td>
</tr>
<tr class="even">
<td class="sorting_1">Caesar Vance</td>
<td>Pre-Sales Support</td>
<td>New York</td>
<td>21</td>
<td>2011/12/12</td>
<td>$106,450</td>
</tr>
<tr class="odd">
<td class="sorting_1">Cara Stevens</td>
<td>Sales Assistant</td>
<td>New York</td>
<td>46</td>
<td>2011/12/06</td>
<td>$145,600</td>
</tr>
<tr class="even">
<td class="sorting_1">Cedric Kelly</td>
<td>Senior Javascript Developer</td>
<td>Edinburgh</td>
<td>22</td>
<td>2012/03/29</td>
<td>$433,060</td>
</tr>
</table>
<ul class="tabs">
<li class="active">Javascript</li>
<li>HTML</li>
<li>CSS</li>
<li>Ajax</li>
<li>Server-side script</li>
</ul>
<div class="tabs">
<div class="js">
<p>The Javascript shown below is used to initialise the table shown in this
example:</p><code class="multiline brush: js;">$(document).ready(function() {
$('#example').dataTable( {
"processing": true,
"serverSide": true,
"ajax": "scripts/server_processing.php",
"deferLoading": 57
} );
} );</code>
<p>In addition to the above code, the following Javascript library files are loaded for use in this
example:</p>
<ul>
<li><a href="../../media/js/jquery.js">../../media/js/jquery.js</a></li>
<li><a href="../../media/js/jquery.dataTables.js">../../media/js/jquery.dataTables.js</a></li>
</ul>
</div>
<div class="table">
<p>The HTML shown below is the raw HTML table element, before it has been enhanced by
DataTables:</p>
</div>
<div class="css">
<div>
<p>This example uses a little bit of additional CSS beyond what is loaded from the library
files (below), in order to correctly display the table. The additional CSS used is shown
below:</p><code class="multiline brush: js;"></code>
</div>
<p>The following CSS library files are loaded for use in this example to provide the styling of the
table:</p>
<ul>
<li><a href=
"../../media/css/jquery.dataTables.css">../../media/css/jquery.dataTables.css</a></li>
</ul>
</div>
<div class="ajax">
<p>This table loads data by Ajax. The latest data that has been loaded is shown below. This data
will update automatically as any additional data is loaded.</p>
</div>
<div class="php">
<p>The script used to perform the server-side processing for this table is shown below. Please note
that this is just an example script using PHP. Server-side processing scripts can be written in any
language, using <a href="//datatables.net/manual/server-side">the protocol described in the
DataTables documentation</a>.</p>
</div>
</div>
</section>
</div>
<section>
<div class="footer">
<div class="gradient"></div>
<div class="liner">
<h2>Other examples</h2>
<div class="toc">
<div class="toc-group">
<h3><a href="../basic_init/index.html">Basic initialisation</a></h3>
<ul class="toc">
<li><a href="../basic_init/zero_configuration.html">Zero configuration</a></li>
<li><a href="../basic_init/filter_only.html">Feature enable / disable</a></li>
<li><a href="../basic_init/table_sorting.html">Default ordering (sorting)</a></li>
<li><a href="../basic_init/multi_col_sort.html">Multi-column ordering</a></li>
<li><a href="../basic_init/multiple_tables.html">Multiple tables</a></li>
<li><a href="../basic_init/hidden_columns.html">Hidden columns</a></li>
<li><a href="../basic_init/complex_header.html">Complex headers (rowspan and
colspan)</a></li>
<li><a href="../basic_init/dom.html">DOM positioning</a></li>
<li><a href="../basic_init/flexible_width.html">Flexible table width</a></li>
<li><a href="../basic_init/state_save.html">State saving</a></li>
<li><a href="../basic_init/alt_pagination.html">Alternative pagination</a></li>
<li><a href="../basic_init/scroll_y.html">Scroll - vertical</a></li>
<li><a href="../basic_init/scroll_x.html">Scroll - horizontal</a></li>
<li><a href="../basic_init/scroll_xy.html">Scroll - horizontal and vertical</a></li>
<li><a href="../basic_init/scroll_y_theme.html">Scroll - vertical with jQuery UI
ThemeRoller</a></li>
<li><a href="../basic_init/comma-decimal.html">Language - Comma decimal place</a></li>
<li><a href="../basic_init/language.html">Language options</a></li>
</ul>
</div>
<div class="toc-group">
<h3><a href="../advanced_init/index.html">Advanced initialisation</a></h3>
<ul class="toc">
<li><a href="../advanced_init/events_live.html">DOM / jQuery events</a></li>
<li><a href="../advanced_init/dt_events.html">DataTables events</a></li>
<li><a href="../advanced_init/column_render.html">Column rendering</a></li>
<li><a href="../advanced_init/length_menu.html">Page length options</a></li>
<li><a href="../advanced_init/dom_multiple_elements.html">Multiple table control
elements</a></li>
<li><a href="../advanced_init/complex_header.html">Complex headers (rowspan /
colspan)</a></li>
<li><a href="../advanced_init/html5-data-attributes.html">HTML5 data-* attributes</a></li>
<li><a href="../advanced_init/language_file.html">Language file</a></li>
<li><a href="../advanced_init/defaults.html">Setting defaults</a></li>
<li><a href="../advanced_init/row_callback.html">Row created callback</a></li>
<li><a href="../advanced_init/row_grouping.html">Row grouping</a></li>
<li><a href="../advanced_init/footer_callback.html">Footer callback</a></li>
<li><a href="../advanced_init/dom_toolbar.html">Custom toolbar elements</a></li>
<li><a href="../advanced_init/sort_direction_control.html">Order direction sequence
control</a></li>
</ul>
</div>
<div class="toc-group">
<h3><a href="../styling/index.html">Styling</a></h3>
<ul class="toc">
<li><a href="../styling/display.html">Base style</a></li>
<li><a href="../styling/no-classes.html">Base style - no styling classes</a></li>
<li><a href="../styling/cell-border.html">Base style - cell borders</a></li>
<li><a href="../styling/compact.html">Base style - compact</a></li>
<li><a href="../styling/hover.html">Base style - hover</a></li>
<li><a href="../styling/order-column.html">Base style - order-column</a></li>
<li><a href="../styling/row-border.html">Base style - row borders</a></li>
<li><a href="../styling/stripe.html">Base style - stripe</a></li>
<li><a href="../styling/bootstrap.html">Bootstrap</a></li>
<li><a href="../styling/foundation.html">Foundation</a></li>
<li><a href="../styling/jqueryUI.html">jQuery UI ThemeRoller</a></li>
</ul>
</div>
<div class="toc-group">
<h3><a href="../data_sources/index.html">Data sources</a></h3>
<ul class="toc">
<li><a href="../data_sources/dom.html">HTML (DOM) sourced data</a></li>
<li><a href="../data_sources/ajax.html">Ajax sourced data</a></li>
<li><a href="../data_sources/js_array.html">Javascript sourced data</a></li>
<li><a href="../data_sources/server_side.html">Server-side processing</a></li>
</ul>
</div>
<div class="toc-group">
<h3><a href="../api/index.html">API</a></h3>
<ul class="toc">
<li><a href="../api/add_row.html">Add rows</a></li>
<li><a href="../api/multi_filter.html">Individual column searching (text inputs)</a></li>
<li><a href="../api/multi_filter_select.html">Individual column searching (select
inputs)</a></li>
<li><a href="../api/highlight.html">Highlighting rows and columns</a></li>
<li><a href="../api/row_details.html">Child rows (show extra / detailed
information)</a></li>
<li><a href="../api/select_row.html">Row selection (multiple rows)</a></li>
<li><a href="../api/select_single_row.html">Row selection and deletion (single
row)</a></li>
<li><a href="../api/form.html">Form inputs</a></li>
<li><a href="../api/counter_columns.html">Index column</a></li>
<li><a href="../api/show_hide.html">Show / hide columns dynamically</a></li>
<li><a href="../api/api_in_init.html">Using API in callbacks</a></li>
<li><a href="../api/tabs_and_scrolling.html">Scrolling and jQuery UI tabs</a></li>
<li><a href="../api/regex.html">Search API (regular expressions)</a></li>
</ul>
</div>
<div class="toc-group">
<h3><a href="../ajax/index.html">Ajax</a></h3>
<ul class="toc">
<li><a href="../ajax/simple.html">Ajax data source (arrays)</a></li>
<li><a href="../ajax/objects.html">Ajax data source (objects)</a></li>
<li><a href="../ajax/deep.html">Nested object data (objects)</a></li>
<li><a href="../ajax/objects_subarrays.html">Nested object data (arrays)</a></li>
<li><a href="../ajax/orthogonal-data.html">Orthogonal data</a></li>
<li><a href="../ajax/null_data_source.html">Generated content for a column</a></li>
<li><a href="../ajax/custom_data_property.html">Custom data source property</a></li>
<li><a href="../ajax/custom_data_flat.html">Flat array data source</a></li>
<li><a href="../ajax/defer_render.html">Deferred rendering for speed</a></li>
</ul>
</div>
<div class="toc-group">
<h3><a href="./index.html">Server-side</a></h3>
<ul class="toc active">
<li><a href="./simple.html">Server-side processing</a></li>
<li><a href="./custom_vars.html">Custom HTTP variables</a></li>
<li><a href="./post.html">POST data</a></li>
<li><a href="./ids.html">Automatic addition of row ID attributes</a></li>
<li><a href="./object_data.html">Object data source</a></li>
<li><a href="./row_details.html">Row details</a></li>
<li><a href="./select_rows.html">Row selection</a></li>
<li><a href="./jsonp.html">JSONP data source for remote domains</a></li>
<li class="active"><a href="./defer_loading.html">Deferred loading of data</a></li>
<li><a href="./pipeline.html">Pipelining data to reduce Ajax calls for paging</a></li>
</ul>
</div>
<div class="toc-group">
<h3><a href="../plug-ins/index.html">Plug-ins</a></h3>
<ul class="toc">
<li><a href="../plug-ins/api.html">API plug-in methods</a></li>
<li><a href="../plug-ins/sorting_auto.html">Ordering plug-ins (with type
detection)</a></li>
<li><a href="../plug-ins/sorting_manual.html">Ordering plug-ins (no type
detection)</a></li>
<li><a href="../plug-ins/range_filtering.html">Custom filtering - range search</a></li>
<li><a href="../plug-ins/dom_sort.html">Live DOM ordering</a></li>
</ul>
</div>
</div>
<div class="epilogue">
<p>Please refer to the <a href="http://www.datatables.net">DataTables documentation</a> for full
information about its API properties and methods.<br>
Additionally, there are a wide range of <a href="http://www.datatables.net/extras">extras</a> and
<a href="http://www.datatables.net/plug-ins">plug-ins</a> which extend the capabilities of
DataTables.</p>
<p class="copyright">DataTables designed and created by <a href=
"http://www.sprymedia.co.uk">SpryMedia Ltd</a> © 2007-2014<br>
DataTables is licensed under the <a href="http://www.datatables.net/mit">MIT license</a>.</p>
</div>
</div>
</div>
</section>
</body>
</html>
|
saimasarifa/web_memorial
|
red_green/plugins/datatables/examples/server_side/defer_loading.html
|
HTML
|
mit
| 16,803 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>ClickAt</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ClickAt";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/thoughtworks/selenium/webdriven/commands/Click.html" title="class in com.thoughtworks.selenium.webdriven.commands"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../com/thoughtworks/selenium/webdriven/commands/Close.html" title="class in com.thoughtworks.selenium.webdriven.commands"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/thoughtworks/selenium/webdriven/commands/ClickAt.html" target="_top">Frames</a></li>
<li><a href="ClickAt.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.thoughtworks.selenium.webdriven.commands</div>
<h2 title="Class ClickAt" class="title">Class ClickAt</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../com/thoughtworks/selenium/webdriven/SeleneseCommand.html" title="class in com.thoughtworks.selenium.webdriven">com.thoughtworks.selenium.webdriven.SeleneseCommand</a><java.lang.Void></li>
<li>
<ul class="inheritance">
<li>com.thoughtworks.selenium.webdriven.commands.ClickAt</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ClickAt</span>
extends <a href="../../../../../com/thoughtworks/selenium/webdriven/SeleneseCommand.html" title="class in com.thoughtworks.selenium.webdriven">SeleneseCommand</a><java.lang.Void></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../com/thoughtworks/selenium/webdriven/commands/ClickAt.html#ClickAt(com.thoughtworks.selenium.webdriven.commands.AlertOverride,%20com.thoughtworks.selenium.webdriven.ElementFinder)">ClickAt</a></strong>(<a href="../../../../../com/thoughtworks/selenium/webdriven/commands/AlertOverride.html" title="class in com.thoughtworks.selenium.webdriven.commands">AlertOverride</a> alertOverride,
<a href="../../../../../com/thoughtworks/selenium/webdriven/ElementFinder.html" title="class in com.thoughtworks.selenium.webdriven">ElementFinder</a> elementFinder)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.Void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/thoughtworks/selenium/webdriven/commands/ClickAt.html#handleSeleneseCommand(org.openqa.selenium.WebDriver,%20java.lang.String,%20java.lang.String)">handleSeleneseCommand</a></strong>(<a href="../../../../../org/openqa/selenium/WebDriver.html" title="interface in org.openqa.selenium">WebDriver</a> driver,
java.lang.String locator,
java.lang.String value)</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.thoughtworks.selenium.webdriven.SeleneseCommand">
<!-- -->
</a>
<h3>Methods inherited from class com.thoughtworks.selenium.webdriven.<a href="../../../../../com/thoughtworks/selenium/webdriven/SeleneseCommand.html" title="class in com.thoughtworks.selenium.webdriven">SeleneseCommand</a></h3>
<code><a href="../../../../../com/thoughtworks/selenium/webdriven/SeleneseCommand.html#apply(org.openqa.selenium.WebDriver,%20java.lang.String[])">apply</a>, <a href="../../../../../com/thoughtworks/selenium/webdriven/SeleneseCommand.html#getTimeout(java.lang.String)">getTimeout</a>, <a href="../../../../../com/thoughtworks/selenium/webdriven/SeleneseCommand.html#setDefaultTimeout(long)">setDefaultTimeout</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ClickAt(com.thoughtworks.selenium.webdriven.commands.AlertOverride, com.thoughtworks.selenium.webdriven.ElementFinder)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ClickAt</h4>
<pre>public ClickAt(<a href="../../../../../com/thoughtworks/selenium/webdriven/commands/AlertOverride.html" title="class in com.thoughtworks.selenium.webdriven.commands">AlertOverride</a> alertOverride,
<a href="../../../../../com/thoughtworks/selenium/webdriven/ElementFinder.html" title="class in com.thoughtworks.selenium.webdriven">ElementFinder</a> elementFinder)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="handleSeleneseCommand(org.openqa.selenium.WebDriver, java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>handleSeleneseCommand</h4>
<pre>protected java.lang.Void handleSeleneseCommand(<a href="../../../../../org/openqa/selenium/WebDriver.html" title="interface in org.openqa.selenium">WebDriver</a> driver,
java.lang.String locator,
java.lang.String value)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../com/thoughtworks/selenium/webdriven/SeleneseCommand.html#handleSeleneseCommand(org.openqa.selenium.WebDriver,%20java.lang.String,%20java.lang.String)">handleSeleneseCommand</a></code> in class <code><a href="../../../../../com/thoughtworks/selenium/webdriven/SeleneseCommand.html" title="class in com.thoughtworks.selenium.webdriven">SeleneseCommand</a><java.lang.Void></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/thoughtworks/selenium/webdriven/commands/Click.html" title="class in com.thoughtworks.selenium.webdriven.commands"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../com/thoughtworks/selenium/webdriven/commands/Close.html" title="class in com.thoughtworks.selenium.webdriven.commands"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/thoughtworks/selenium/webdriven/commands/ClickAt.html" target="_top">Frames</a></li>
<li><a href="ClickAt.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|
SevInf/IEDriver
|
docs/api/java/com/thoughtworks/selenium/webdriven/commands/ClickAt.html
|
HTML
|
apache-2.0
| 11,584 |
<div>
The URL of the Jenkins Master server.
</div>
|
azweb76/kubernetes-plugin
|
src/main/resources/org/csanchez/jenkins/plugins/kubernetes/KubernetesCloud/help-jenkinsUrl.html
|
HTML
|
apache-2.0
| 54 |
<!DOCTYPE html>
<!--
Copyright (c) 2013 The Chromium Authors. All rights reserved.
Use of this source code is governed by a BSD-style license that can be
found in the LICENSE file.
-->
<link rel="import" href="/tracing/base/task.html">
<link rel="import" href="/tracing/core/test_utils.html">
<link rel="import" href="/tracing/extras/importer/trace_event_importer.html">
<link rel="import" href="/tracing/model/event_set.html">
<link rel="import" href="/tracing/ui/brushing_state_controller.html">
<script>
'use strict';
tr.b.unittest.testSuite(function() {
const newSliceEx = tr.c.TestUtils.newSliceEx;
const EventSet = tr.model.EventSet;
const SelectionState = tr.model.SelectionState;
const Task = tr.b.Task;
function newSimpleFakeTimelineView() {
const m = tr.c.TestUtils.newModel(function(m) {
m.p1 = m.getOrCreateProcess(1);
m.t2 = m.p1.getOrCreateThread(2);
m.sA = m.t2.sliceGroup.pushSlice(
newSliceEx({title: 'a', start: 0, end: 5}));
m.sB = m.t2.sliceGroup.pushSlice(
newSliceEx({title: 'b', start: 10, end: 15}));
m.sC = m.t2.sliceGroup.pushSlice(
newSliceEx({title: 'c', start: 20, end: 20}));
});
// Fake timeline view. So fake its ... just wow.
const timelineView = {
model: m
};
return timelineView;
}
function doesCauseChangeToFire(brushingStateController, cb, opt_this) {
let didFire = false;
function didFireCb() {
didFire = true;
}
brushingStateController.addEventListener('change', didFireCb);
cb.call(opt_this);
brushingStateController.removeEventListener('change', didFireCb);
return didFire;
}
test('simpleStateChanges', function() {
const timelineView = newSimpleFakeTimelineView();
const brushingStateController =
new tr.c.BrushingStateController(timelineView);
const m = timelineView.model;
// Setting empty brushing state doesn't cause change event. This behavior
// is triggered when the user tries to search for something when no trace
// has been loaded yet in chrome://tracing.
const bs0 = new tr.ui.b.BrushingState();
assert.isFalse(doesCauseChangeToFire(
brushingStateController,
function() {
brushingStateController.currentBrushingState = bs0;
}));
assert.isFalse(bs0.isAppliedToModel);
assert.strictEqual(brushingStateController.currentBrushingState, bs0);
// Setting causes change.
const bs1 = new tr.ui.b.BrushingState();
bs1.selection = new EventSet([m.sA]);
assert.isTrue(doesCauseChangeToFire(
brushingStateController,
function() {
brushingStateController.currentBrushingState = bs1;
}));
assert.isTrue(bs1.isAppliedToModel);
// Setting value equivalent doesn't cause change event.
const bs2 = bs1.clone();
assert.isFalse(doesCauseChangeToFire(
brushingStateController,
function() {
brushingStateController.currentBrushingState = bs2;
}));
assert.strictEqual(brushingStateController.currentBrushingState, bs2);
assert.isTrue(
brushingStateController.currentBrushingState.isAppliedToModel);
// Setting to something different unapplies the old bs.
const bs3 = new tr.ui.b.BrushingState();
bs3.findMatches = new EventSet([m.sA, m.sB]);
brushingStateController.currentBrushingState = bs3;
assert.isTrue(bs3.isAppliedToModel);
assert.isFalse(bs2.isAppliedToModel);
});
test('modelCausesStateChange', function() {
const timelineView = newSimpleFakeTimelineView();
const brushingStateController =
new tr.c.BrushingStateController(timelineView);
const m1 = timelineView.model;
const bs1 = new tr.ui.b.BrushingState();
bs1.selection = new EventSet([m1.sA]);
// Change the model.
const m2 = tr.c.TestUtils.newModel(function(m) {
m.p1 = m.getOrCreateProcess(1);
m.t2 = m.p1.getOrCreateThread(2);
m.sA = m.t2.sliceGroup.pushSlice(
newSliceEx({title: 'a', start: 0, end: 5}));
});
assert.isTrue(doesCauseChangeToFire(
brushingStateController,
function() {
brushingStateController.modelWillChange();
timelineView.model = m2;
brushingStateController.modelDidChange();
}));
assert.strictEqual(
brushingStateController.currentBrushingState.selection.length, 0);
});
function addChildDiv(element) {
const child = element.ownerDocument.createElement('div');
Polymer.dom(element).appendChild(child);
return child;
}
function addShadowChildDiv(element) {
const shadowRoot = element.createShadowRoot();
return addChildDiv(shadowRoot);
}
if (!tr.isHeadless) {
test('getControllerForElement_none', function() {
const element = document.createElement('div');
assert.isUndefined(
tr.c.BrushingStateController.getControllerForElement(element));
});
test('getControllerForElement_self', function() {
const controller = new tr.c.BrushingStateController(undefined);
const element = document.createElement('div');
element.brushingStateController = controller;
assert.strictEqual(
tr.c.BrushingStateController.getControllerForElement(element),
controller);
});
test('getControllerForElement_ancestor', function() {
const controller = new tr.c.BrushingStateController(undefined);
const ancestor = document.createElement('div');
ancestor.brushingStateController = controller;
const element = addChildDiv(addChildDiv(addChildDiv(ancestor)));
assert.strictEqual(
tr.c.BrushingStateController.getControllerForElement(element),
controller);
});
test('getControllerForElement_host', function() {
const controller = new tr.c.BrushingStateController(undefined);
const host = document.createElement('div');
host.brushingStateController = controller;
const element = addShadowChildDiv(host);
assert.strictEqual(
tr.c.BrushingStateController.getControllerForElement(element),
controller);
});
test('getControllerForElement_hierarchy', function() {
const controller1 = new tr.c.BrushingStateController(undefined);
const root = document.createElement('div');
root.brushingStateController = controller1;
const controller2 = new tr.c.BrushingStateController(undefined);
const child = addChildDiv(root);
child.brushingStateController = controller2;
const controller3 = new tr.c.BrushingStateController(undefined);
const shadowChild = addShadowChildDiv(child);
shadowChild.brushingStateController = controller3;
const element = addChildDiv(addChildDiv(addShadowChildDiv(
addChildDiv(addChildDiv(addShadowChildDiv(
addChildDiv(shadowChild)))))));
assert.strictEqual(
tr.c.BrushingStateController.getControllerForElement(element),
controller3);
});
}
});
</script>
|
catapult-project/catapult
|
tracing/tracing/ui/brushing_state_controller_test.html
|
HTML
|
bsd-3-clause
| 7,041 |
<!DOCTYPE html>
<!--
Copyright 2015 The Chromium Authors. All rights reserved.
Use of this source code is governed by a BSD-style license that can be
found in the LICENSE file.
-->
<link rel="import" href="/tracing/base/task.html">
<link rel="import" href="/tracing/core/filter.html">
<link rel="import" href="/tracing/core/scripting_object.html">
<link rel="import" href="/tracing/extras/tquery/context.html">
<link rel="import" href="/tracing/extras/tquery/filter_all_of.html">
<link rel="import" href="/tracing/extras/tquery/filter_any_of.html">
<link rel="import" href="/tracing/extras/tquery/filter_has_ancestor.html">
<link rel="import" href="/tracing/extras/tquery/filter_has_duration.html">
<link rel="import" href="/tracing/extras/tquery/filter_has_title.html">
<link rel="import" href="/tracing/extras/tquery/filter_is_top_level.html">
<link rel="import" href="/tracing/extras/tquery/filter_not.html">
<link rel="import" href="/tracing/model/event_set.html">
<script>
'use strict';
tr.exportTo('tr.e.tquery', function() {
function addEventTreeToSelection(selection, event) {
selection.push(event);
if (!event.subSlices) return;
event.subSlices.forEach(
addEventTreeToSelection.bind(undefined, selection));
}
function TQuery(model) {
tr.c.ScriptingObject.call(this);
this.model_ = model;
this.parent_ = undefined;
this.filterExpression_ = undefined;
// Memoized filtering result.
this.selection_ = undefined;
}
TQuery.prototype = {
__proto__: tr.c.ScriptingObject.prototype,
onModelChanged(model) {
this.model_ = model;
this.selection_ = undefined;
},
get brushingStateController() {
return this.brushingStateController_;
},
// Append a new filter expression to this query and return a query node
// that represents the result.
filter(filterExpression) {
const result = new TQuery(this.model_);
result.parent_ = this;
result.filterExpression_ =
tr.e.tquery.Filter.normalizeFilterExpression(filterExpression);
return result;
},
// Creates a graph of {Task} objects which will compute the selections for
// this filter object and all of its parents. The return value is an object
// with the following fields:
// - rootTask: {Task} which should be executed to kick off processing for
// the entire task graph.
// - lastTask: The final {Task} of the graph. Can be used by the caller to
// enqueue additional processing at the end.
// - lastNode: The last filter object in the task. It's selection property
// will contain the filtering result once |finalTask|
// completes.
createFilterTaskGraph_() {
// List of nodes in order from the current one to the root.
const nodes = [this];
while (nodes[nodes.length - 1].parent_) {
nodes.push(nodes[nodes.length - 1].parent_);
}
const rootTask = new tr.b.Task();
let lastTask = rootTask;
let node;
for (let i = nodes.length - 1; i >= 0; i--) {
node = nodes[i];
// Reuse any memoized result.
if (node.selection_ !== undefined) continue;
node.selection_ = new tr.model.EventSet();
if (node.parent_ === undefined) {
// If this is the root, start by collecting all objects from the
// model.
lastTask = lastTask.after(
this.selectEverythingAsTask_(node.selection_));
} else {
// Otherwise execute the filter expression for this node and fill
// in its selection.
const prevNode = nodes[i + 1];
lastTask = this.createFilterTaskForNode_(lastTask, node, prevNode);
}
}
return {rootTask, lastTask, lastNode: node};
},
createFilterTaskForNode_(lastTask, node, prevNode) {
return lastTask.after(function() {
// TODO(skyostil): Break into subtasks.
node.evaluateFilterExpression_(
prevNode.selection_, node.selection_);
}, this);
},
// Applies the result of a filter expression for a given event and all
// of its subslices and adds the matching events to an output selection.
evaluateFilterExpression_(inputSelection, outputSelection) {
const seenEvents = {};
inputSelection.forEach(function(event) {
const context = new tr.e.tquery.Context();
context.event = event;
this.evaluateFilterExpressionForEvent_(
context, inputSelection, outputSelection, seenEvents);
}.bind(this));
},
evaluateFilterExpressionForEvent_(
context, inputSelection, outputSelection, seenEvents) {
const event = context.event;
if (inputSelection.contains(event) && !seenEvents[event.guid]) {
seenEvents[event.guid] = true;
if (!this.filterExpression_ ||
this.filterExpression_.evaluate(context)) {
outputSelection.push(event);
}
}
if (!event.subSlices) return;
context = context.push(event);
for (let i = 0; i < event.subSlices.length; i++) {
context.event = event.subSlices[i];
this.evaluateFilterExpressionForEvent_(
context, inputSelection, outputSelection, seenEvents);
}
},
// Returns a task that fills the given selection with everything in the
// model.
selectEverythingAsTask_(selection) {
const filterTask = new tr.b.Task();
for (const container of this.model_.getDescendantEventContainers()) {
filterTask.subTask(() => {
for (const event of container.childEvents()) {
addEventTreeToSelection(selection, event);
}
}, this);
}
return filterTask;
},
// Returns a promise which will resolve into a {EventSet} representing the
// result of this query.
ready() {
return new Promise(function(resolve, reject) {
const graph = this.createFilterTaskGraph_();
graph.lastTask = graph.lastTask.after(function() {
resolve(this.selection_);
}, this);
tr.b.Task.RunWhenIdle(graph.rootTask);
}.bind(this));
},
get selection() {
if (this.selection_ === undefined) {
const graph = this.createFilterTaskGraph_();
tr.b.Task.RunSynchronously(graph.rootTask);
}
return this.selection_;
}
};
tr.c.ScriptingObjectRegistry.register(
new TQuery(),
{
name: '$t'
}
);
return {
TQuery,
};
});
</script>
|
catapult-project/catapult
|
tracing/tracing/extras/tquery/tquery.html
|
HTML
|
bsd-3-clause
| 6,556 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_11) on Thu Jul 10 09:58:50 CDT 2008 -->
<TITLE>
Uses of Interface net.didion.jwnl.dictionary.file_manager.FileManager
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Uses of Interface net.didion.jwnl.dictionary.file_manager.FileManager";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager"><FONT CLASS="NavBarFont1"><B>Class</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?net/didion/jwnl/dictionary/file_manager/\class-useFileManager.html" target="_top"><B>FRAMES</B></A>
<A HREF="FileManager.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<CENTER>
<H2>
<B>Uses of Interface<br>net.didion.jwnl.dictionary.file_manager.FileManager</B></H2>
</CENTER>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
Packages that use <A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager">FileManager</A></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><A HREF="#net.didion.jwnl.dictionary"><B>net.didion.jwnl.dictionary</B></A></TD>
<TD>Classes for acessing dictionary information. </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><A HREF="#net.didion.jwnl.dictionary.file_manager"><B>net.didion.jwnl.dictionary.file_manager</B></A></TD>
<TD>Classes used by <code>FileBackedDictionary</code> to interface with the filesystem. </TD>
</TR>
</TABLE>
<P>
<A NAME="net.didion.jwnl.dictionary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
Uses of <A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager">FileManager</A> in <A HREF="../../../../../../net/didion/jwnl/dictionary/package-summary.html">net.didion.jwnl.dictionary</A></FONT></TH>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left" COLSPAN="2">Methods in <A HREF="../../../../../../net/didion/jwnl/dictionary/package-summary.html">net.didion.jwnl.dictionary</A> with parameters of type <A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager">FileManager</A></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B>FileBackedDictionary.</B><B><A HREF="../../../../../../net/didion/jwnl/dictionary/FileBackedDictionary.html#install(net.didion.jwnl.dictionary.file_manager.FileManager, net.didion.jwnl.data.FileDictionaryElementFactory)">install</A></B>(<A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager">FileManager</A> fileManager,
<A HREF="../../../../../../net/didion/jwnl/data/FileDictionaryElementFactory.html" title="interface in net.didion.jwnl.data">FileDictionaryElementFactory</A> factory)</CODE>
<BR>
Construct a Dictionary that retrieves file data from <code>fileManager</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B>FileBackedDictionary.</B><B><A HREF="../../../../../../net/didion/jwnl/dictionary/FileBackedDictionary.html#install(net.didion.jwnl.dictionary.file_manager.FileManager, net.didion.jwnl.data.FileDictionaryElementFactory, boolean)">install</A></B>(<A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager">FileManager</A> fileManager,
<A HREF="../../../../../../net/didion/jwnl/data/FileDictionaryElementFactory.html" title="interface in net.didion.jwnl.data">FileDictionaryElementFactory</A> factory,
boolean enableCaching)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B>FileBackedDictionary.</B><B><A HREF="../../../../../../net/didion/jwnl/dictionary/FileBackedDictionary.html#install(net.didion.jwnl.dictionary.file_manager.FileManager, net.didion.jwnl.dictionary.MorphologicalProcessor, net.didion.jwnl.data.FileDictionaryElementFactory)">install</A></B>(<A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager">FileManager</A> fileManager,
<A HREF="../../../../../../net/didion/jwnl/dictionary/MorphologicalProcessor.html" title="interface in net.didion.jwnl.dictionary">MorphologicalProcessor</A> morph,
<A HREF="../../../../../../net/didion/jwnl/data/FileDictionaryElementFactory.html" title="interface in net.didion.jwnl.data">FileDictionaryElementFactory</A> factory)</CODE>
<BR>
Construct a Dictionary that retrieves file data from <code>fileManager</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B>FileBackedDictionary.</B><B><A HREF="../../../../../../net/didion/jwnl/dictionary/FileBackedDictionary.html#install(net.didion.jwnl.dictionary.file_manager.FileManager, net.didion.jwnl.dictionary.MorphologicalProcessor, net.didion.jwnl.data.FileDictionaryElementFactory, boolean)">install</A></B>(<A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager">FileManager</A> fileManager,
<A HREF="../../../../../../net/didion/jwnl/dictionary/MorphologicalProcessor.html" title="interface in net.didion.jwnl.dictionary">MorphologicalProcessor</A> morph,
<A HREF="../../../../../../net/didion/jwnl/data/FileDictionaryElementFactory.html" title="interface in net.didion.jwnl.data">FileDictionaryElementFactory</A> factory,
boolean enableCaching)</CODE>
<BR>
</TD>
</TR>
</TABLE>
<P>
<A NAME="net.didion.jwnl.dictionary.file_manager"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
Uses of <A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager">FileManager</A> in <A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/package-summary.html">net.didion.jwnl.dictionary.file_manager</A></FONT></TH>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left" COLSPAN="2">Classes in <A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/package-summary.html">net.didion.jwnl.dictionary.file_manager</A> that implement <A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager">FileManager</A></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManagerImpl.html" title="class in net.didion.jwnl.dictionary.file_manager">FileManagerImpl</A></B></CODE>
<BR>
An implementation of <code>FileManager</code> that reads files from the local file system.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/RemoteFileManager.html" title="class in net.didion.jwnl.dictionary.file_manager">RemoteFileManager</A></B></CODE>
<BR>
An object of this class can serve as a <code>FileManager</code> for remote <code>FileBackedDictionary</code>
instantiations using RMI.</TD>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left" COLSPAN="2">Methods in <A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/package-summary.html">net.didion.jwnl.dictionary.file_manager</A> that return <A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager">FileManager</A></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager">FileManager</A></CODE></FONT></TD>
<TD><CODE><B>RemoteFileManager.</B><B><A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/RemoteFileManager.html#lookup(java.lang.String)">lookup</A></B>(java.lang.String hostname)</CODE>
<BR>
Lookup the object bound to the value of <code>BINDING_NAME</code> in the RMI
registry on the host named by <var>hostname</var></TD>
</TR>
</TABLE>
<P>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../net/didion/jwnl/dictionary/file_manager/FileManager.html" title="interface in net.didion.jwnl.dictionary.file_manager"><FONT CLASS="NavBarFont1"><B>Class</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?net/didion/jwnl/dictionary/file_manager/\class-useFileManager.html" target="_top"><B>FRAMES</B></A>
<A HREF="FileManager.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|
xavi-reloaded/java-wordnet-maven
|
src/main/resources/doc/javadoc/net/didion/jwnl/dictionary/file_manager/class-use/FileManager.html
|
HTML
|
bsd-3-clause
| 15,257 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html40/loose.dtd">
<HTML>
<!-- Created on December, 31 2009 by texi2html 1.66 -->
<!--
Written by: Lionel Cons <[email protected]> (original author)
Karl Berry <[email protected]>
Olaf Bachmann <[email protected]>
and many others.
Maintained by: Many creative people <[email protected]>
Send bugs and suggestions to <[email protected]>
-->
<HEAD>
<TITLE>OGRE Manual v1.7 ('Cthugha'): Entities</TITLE>
<META NAME="description" CONTENT="OGRE Manual v1.7 ('Cthugha'): Entities">
<META NAME="keywords" CONTENT="OGRE Manual v1.7 ('Cthugha'): Entities">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="texi2html 1.66">
<LINK TYPE="text/css" rel="stylesheet" href="../style.css">
</HEAD>
<BODY LANG="en" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000">
<A NAME="SEC13"></A>
<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_9.html#SEC12"> < </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_11.html#SEC14"> > </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_4.html#SEC4"> << </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_4.html#SEC4"> Up </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_13.html#SEC22"> >> </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="index.html#SEC_Top">Top</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_toc.html#SEC_Contents">Contents</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[Index]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_abt.html#SEC_About"> ? </A>]</TD>
</TR></TABLE>
<HR SIZE=1>
<H2> 2.6 Entities </H2>
<!--docid::SEC13::-->
An entity is an instance of a movable object in the scene. It could be a car, a person, a dog, a shuriken, whatever. The only assumption is that it does not necessarily have a fixed position in the world.<BR><BR>
Entities are based on discrete meshes, i.e. collections of geometry which are self-contained and typically fairly small on a world scale, which are represented by the Mesh object. Multiple entities can be based on the same mesh, since often you want to create multiple copies of the same type of object in a scene.<BR><BR>
You create an entity by calling the SceneManager::createEntity method, giving it a name and specifying the name of the mesh object which it will be based on (e.g. 'muscleboundhero.mesh'). The SceneManager will ensure that the mesh is loaded by calling the MeshManager resource manager for you. Only one copy of the Mesh will be loaded.<BR><BR>
Entities are not deemed to be a part of the scene until you attach them to a SceneNode (see the section below). By attaching entities to SceneNodes, you can create complex hierarchical relationships between the positions and orientations of entities. You then modify the positions of the nodes to indirectly affect the entity positions.<BR><BR>
When a Mesh is loaded, it automatically comes with a number of materials defined. It is possible to have more than one material attached to a mesh - different parts of the mesh may use different materials. Any entity created from the mesh will automatically use the default materials. However, you can change this on a per-entity basis if you like so you can create a number of entities based on the same mesh but with different textures etc.<BR><BR>
To understand how this works, you have to know that all Mesh objects are actually composed of SubMesh objects, each of which represents a part of the mesh using one Material. If a Mesh uses only one Material, it will only have one SubMesh.<BR><BR>
When an Entity is created based on this Mesh, it is composed of (possibly) multiple SubEntity objects, each matching 1 for 1 with the SubMesh objects from the original Mesh. You can access the SubEntity objects using the Entity::getSubEntity method. Once you have a reference to a SubEntity, you can change the material it uses by calling it's setMaterialName method. In this way you can make an Entity deviate from the default materials and thus create an individual looking version of it.<BR><BR>
<A NAME="Materials"></A>
<HR SIZE=1>
<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_9.html#SEC12"> < </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_11.html#SEC14"> > </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_4.html#SEC4"> << </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_4.html#SEC4"> Up </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_13.html#SEC22"> >> </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT"> <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="index.html#SEC_Top">Top</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_toc.html#SEC_Contents">Contents</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[Index]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="manual_abt.html#SEC_About"> ? </A>]</TD>
</TR></TABLE>
<BR>
<FONT SIZE="-1">
This document was generated
by <I>Steve Streeting</I> on <I>December, 31 2009</I>
using <A HREF="http://texi2html.cvshome.org"><I>texi2html</I></A>
</FONT>
</BODY>
</HTML>
|
ruleless/ogre
|
Docs/manual/manual_10.html
|
HTML
|
mit
| 5,734 |
{#
basic/layout.html
~~~~~~~~~~~~~~~~~
Master layout template for Imagine themes.
:copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- block doctype -%}
<!DOCTYPE html>
{%- endblock %}
{%- set reldelim1 = reldelim1 is not defined and ' »' or reldelim1 %}
{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and
(sidebars != []) %}
{%- set url_root = pathto('', 1) %}
{# XXX necessary? #}
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
{%- if not embedded and docstitle %}
{%- set titlesuffix = " — "|safe + docstitle|e %}
{%- else %}
{%- set titlesuffix = "" %}
{%- endif %}
{%- macro relbar() %}
<aside class="related">
<h3>{{ _('Navigation') }}</h3>
<ul>
{%- for rellink in rellinks %}
<li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}>
<a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
{%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>
{%- endfor %}
{%- block rootrellink %}
<li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
{%- endblock %}
{%- for parent in parents %}
<li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>
{%- endfor %}
{%- block relbaritems %} {% endblock %}
</ul>
</aside>
{%- endmacro %}
{%- macro sidebar() %}
{%- if render_sidebar %}
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
{%- block sidebarlogo %}
{%- if logo %}
<p class="logo"><a href="{{ pathto(master_doc) }}">
<img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
</a></p>
{%- endif %}
{%- endblock %}
{%- if sidebars != None %}
{#- new style sidebar: explicitly include/exclude templates #}
{%- for sidebartemplate in sidebars %}
{%- include sidebartemplate %}
{%- endfor %}
{%- else %}
{#- old style sidebars: using blocks -- should be deprecated #}
{%- block sidebartoc %}
{%- include "localtoc.html" %}
{%- endblock %}
{%- block sidebarrel %}
{%- include "relations.html" %}
{%- endblock %}
{%- block sidebarsourcelink %}
{%- include "sourcelink.html" %}
{%- endblock %}
{%- if customsidebar %}
{%- include customsidebar %}
{%- endif %}
{%- block sidebarsearch %}
{%- include "searchbox.html" %}
{%- endblock %}
{%- endif %}
</div>
</div>
{%- endif %}
{%- endmacro %}
{%- macro script() %}
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '{{ url_root }}',
VERSION: '{{ release|e }}',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
HAS_SOURCE: {{ has_source|lower }}
};
</script>
{%- for scriptfile in script_files %}
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
{%- endfor %}
{%- endmacro %}
{%- macro css() %}
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
{%- for cssfile in css_files %}
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
{%- endfor %}
{%- endmacro %}
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset={{ encoding }}" />
{{ metatags }}
{%- block htmltitle %}
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
{%- endblock %}
{{ css() }}
{%- if not embedded %}
{{ script() }}
{%- if use_opensearch %}
<link rel="search" type="application/opensearchdescription+xml"
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
href="{{ pathto('_static/opensearch.xml', 1) }}"/>
{%- endif %}
{%- if favicon %}
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
{%- endif %}
{%- endif %}
{%- block linktags %}
{%- if hasdoc('about') %}
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
{%- endif %}
{%- if hasdoc('genindex') %}
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
{%- endif %}
{%- if hasdoc('search') %}
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
{%- endif %}
{%- if hasdoc('copyright') %}
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
{%- endif %}
<link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
{%- if parents %}
<link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" />
{%- endif %}
{%- if next %}
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
{%- endif %}
{%- if prev %}
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
{%- endif %}
{%- endblock %}
{%- block extrahead %} {% endblock %}
</head>
<body>
{%- block content %}
{%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}
<div class="document" role="main">
{%- block header %}
<header>
{%- if logo and not render_sidebar %}
<p class="logo"><a href="{{ pathto(master_doc) }}">
<img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
</a></p>
{%- endif %}
{% if theme_github_fork %}
<a href="http://github.com/{{ theme_github_fork }}"><img style="position: fixed; top: 0; right: 0; border: 0;"
src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
{% endif %}
</header>
{% endblock %}
{% if render_sidebar %}
{%- block relbar1 %}{{ relbar() }}{% endblock %}
{% endif %}
{%- block document %}
{%- block sidebar2 %}{{ sidebar() }}{% endblock %}
<div class="documentwrapper">
{%- if render_sidebar %}
<div class="bodywrapper">
{%- endif %}
<div class="body">
{% block body %} {% endblock %}
</div>
{%- if render_sidebar %}
</div>
{%- endif %}
</div>
{%- endblock %}
{% if render_sidebar %}
{%- block relbar2 %}{{ relbar() }}{% endblock %}
{% endif %}
<div id="disqus_thread"></div>
<script type="text/javascript">
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
var disqus_shortname = 'imagine-php'; // required: replace example with your forum shortname
/* * * DON'T EDIT BELOW THIS LINE * * */
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
{%- block footer %}
<footer>
{%- if show_copyright %}
{%- if hasdoc('copyright') %}
{% trans path=pathto('copyright'), copyright=copyright|e %}© <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
{%- else %}
{% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %}
{%- endif %}
{%- endif %}
{%- if last_updated %}
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
{%- endif %}
{%- if show_sphinx %}
{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
{%- endif %}
</footer>
{%- endblock %}
</div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-26645834-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
{%- endblock %}
</body>
</html>
|
vcabourdin/weblabs
|
vendor/imagine/docs/_themes/imagine/layout.html
|
HTML
|
mit
| 9,273 |
<!DOCTYPE html>
<html ⚡>
<head>
<meta charset="utf-8">
<link rel="canonical" href="https://amp.dev/documentation/examples/components/amp-lightbox-gallery/index.html">
<meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1">
<script async src="https://cdn.ampproject.org/v0.js"></script>
<title>amp-lightbox-gallery</title>
<script async custom-element="amp-lightbox-gallery" src="https://cdn.ampproject.org/v0/amp-lightbox-gallery-0.1.js"></script>
<script async custom-element="amp-carousel" src="https://cdn.ampproject.org/v0/amp-carousel-0.1.js"></script>
<style amp-boilerplate>body{-webkit-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-moz-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-ms-animation:-amp-start 8s steps(1,end) 0s 1 normal both;animation:-amp-start 8s steps(1,end) 0s 1 normal both}@-webkit-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-moz-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-ms-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-o-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}</style><noscript><style amp-boilerplate>body{-webkit-animation:none;-moz-animation:none;-ms-animation:none;animation:none}</style></noscript>
<style amp-custom>
amp-carousel{
max-width: 400px;
margin-bottom: 100px;
}
.amp-lightbox-gallery-caption{
color: red;
font-size: 30px;
}
</style>
</head>
<body>
<h2>AMP lightbox gallery with just regualar old jpgs.</h2>
<amp-img
lightbox
src="https://picsum.photos/id/494/400/400.jpg"
layout="fixed"
width="400"
height="400"
>
</amp-img>
<amp-img
lightbox
src="https://picsum.photos/id/525/400/400.jpg"
layout="fixed"
width="400"
height="400"
>
</amp-img>
<amp-img
lightbox
src="https://picsum.photos/id/78/400/400.jpg"
layout="fixed"
width="400"
height="400"
>
</amp-img>
<h2>AMP lightbox gallery with caption styling.</h2>
<p>We set captions to be colored red and have a 30px font size.</p>
<div class="container" style="display: flex">
<figure class="dog-walking-caption">
<amp-img
lightbox
src="https://picsum.photos/id/494/400/400.jpg"
layout="fixed"
width="400"
height="400"
></amp-img>
<figcaption>
Let's walk the dog.
</figcaption>
</figure>
<figure class="desert-caption">
<amp-img
lightbox="caption"
src="https://picsum.photos/id/525/400/400.jpg"
layout="fixed"
width="400"
height="400"
></amp-img>
<figcaption>
This is the desert.
</figcaption>
</figure>
<figure class="door-caption">
<amp-img
lightbox
src="https://picsum.photos/id/78/400/400.jpg"
layout="fixed"
width="400"
height="400"
></amp-img>
<figcaption>
This is a door.
</figcaption>
</figure>
</div>
<h2>AMP lightbox gallery with webp and jpeg fallback.</h2>
<p>This doesnt work in browsers that doesnt support webp</p>
<amp-img
lightbox
src="https://picsum.photos/id/494/400/400sdfsdf.webp"
layout="fixed"
width="400"
height="400"
>
<amp-img
fallback
src="https://picsum.photos/id/494/400/400.jpg"
layout="fill"
></amp-img>
</amp-img>
<amp-img
lightbox
src="https://picsum.photos/id/525/400/400.webp"
layout="fixed"
width="400"
height="400"
>
<amp-img
fallback
src="https://picsum.photos/id/525/400/400.jpg"
layout="fill"
></amp-img>
</amp-img>
<amp-img
lightbox
src="https://picsum.photos/id/78/400/400.webp"
layout="fixed"
width="400"
height="400"
>
<amp-img
fallback
src="https://picsum.photos/id/78/400/400.jpg"
layout="fill"
></amp-img>
</amp-img>
<h2>AMP Carousel with just regualar old jpgs.</h2>
<amp-carousel
class="storslider"
width="400"
height="400"
layout="fixed"
type="slides"
lightbox
loop
>
<amp-img
src="https://picsum.photos/id/494/400/400.jpg"
layout="fill"
></amp-img>
<amp-img
src="https://picsum.photos/id/525/400/400.jpg"
layout="fill"
></amp-img>
<amp-img
src="https://picsum.photos/id/78/400/400.jpg"
layout="fill"
></amp-img>
</amp-carousel>
<h2>AMP Carousel with webp and jpeg fallback.</h2>
<p>This doesnt work in browsers that doesnt support webp</p>
<amp-carousel
class="storslider"
width="400"
height="400"
layout="fixed"
type="slides"
lightbox
loop
>
<amp-img src="https://picsum.photos/id/494/400/400.webp" layout="fill">
<amp-img
fallback
src="https://picsum.photos/id/494/400/400.jpg"
layout="fill"
></amp-img>
</amp-img>
<amp-img src="https://picsum.photos/id/525/400/400.webp" layout="fill">
<amp-img
fallback
src="https://picsum.photos/id/525/400/400.jpg"
layout="fill"
></amp-img>
</amp-img>
<amp-img src="https://picsum.photos/id/78/400/400.webp" layout="fill">
<amp-img
fallback
src="https://picsum.photos/id/78/400/400.jpg"
layout="fill"
></amp-img>
</amp-img>
</amp-carousel>
</body>
</html>
|
prateekbh/amphtml
|
examples/lightbox-gallery.amp.html
|
HTML
|
apache-2.0
| 5,846 |
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<title>scan (Dia::Uml::ObjectBase)</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
</head>
<body class="standalone-code">
<pre> <span class="ruby-comment cmt"># File Dia/DiaUml.rb, line 333</span>
333: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">scan</span>()
334: <span class="ruby-identifier">scanParent</span>() ;
335: <span class="ruby-identifier">scanName</span>() ;
336: <span class="ruby-identifier">scanSub</span>() ;
337: <span class="ruby-keyword kw">end</span></pre>
</body>
</html>
|
noda50/RubyItk
|
doc/classes/Dia/Uml/ObjectBase.src/M000125.html
|
HTML
|
apache-2.0
| 888 |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<!--basic styles-->
<link href="asset/css/bootstrap.css" rel="stylesheet" />
<link rel="stylesheet" href="asset/css/dexter.min.css" />
<link rel="stylesheet" href="asset/css/font-awesome.min.css" />
<!--[if IE 7]>
<link rel="stylesheet" href="asset/css/font-awesome-ie7.min.css">
<![endif]-->
<link rel="stylesheet" href="asset/css/prettify.css" />
<script src="asset/js/jquery-2.0.3.min.js"></script>
<!--[if IE]>
<script src="asset/js/jquery.min.js"></script>
<![endif]-->
<script src="asset/js/prettify.js"></script>
<script type="text/javascript">
$(function() {
window.prettyPrint && prettyPrint();
$('#id-check-horizontal').removeAttr('checked').on('click', function(){
$('#dt-list-1').toggleClass('dl-horizontal').prev().html(this.checked ? '<dl class="dl-horizontal">' : '<dl>');
});
})
</script>
</head>
<body>
<div class="space-12"></div>
<div class="table-grid-info table-grid-info-striped">
<div class="table-grid-row">
<div class="table-grid-label"> Checker Code</div>
<div class="table-grid-value"><h5 class="header blue"><i class="fa fa-bug"></i>
obsoleteFunctionsscalbln</h5>
</div>
</div>
<div class="table-grid-row">
<div class="table-grid-label"> Description </div>
<div class="table-grid-value-highlight"><i class="fa fa-th"></i>
Avoid usage of the obsolete function 'scalbln'.
</div>
</div>
<div class="table-grid-row">
<div class="table-grid-label"> Severity </div>
<div class="table-grid-value">
Minor
</div>
</div>
<div class="table-grid-row">
<div class="table-grid-label"> Detector / Bug Pattern </div>
<div class="table-grid-value">
Avoid usage of the obsolete function 'scalbln'.
</div>
</div>
<div class="table-grid-row">
<div class="table-grid-label"> More Information </div>
<div class="table-grid-value">
Avoid usage of the obsolete function 'scalbln'.
</div>
</div>
<div class="table-grid-row">
<div class="table-grid-label"> Bad Code </div>
<div class="table-grid-value">
<pre class="prettyprint linenums warning">
</pre>
</div>
</div>
<div class="table-grid-row">
<div class="table-grid-label"> Good Code </div>
<div class="table-grid-value">
<pre class="prettyprint linenums correct">
</pre>
</div>
</div>
<div class="table-grid-row">
<div class="table-grid-label"> CWE ID </div>
<div class="table-grid-value">
<a href="asset/CWE_ID.html" target="_blank">0 </a>
</div>
</div>
<div class="table-grid-row">
<div class="table-grid-label"> Code Review Asset </div>
<div class="table-grid-value">
N/A
</div>
</div>
<div class="table-grid-row">
<div class="table-grid-label"> URLs </div>
<div class="table-grid-value"> <i class="fa fa-link"></i>
<a target="_blank" href="#">
</a>
</div>
</div>
</div>
<div class="space-20"></div>
</body>
<html>
|
Minjung-Baek/Dexter
|
project/dexter-server/public/tool/cppcheck/CPP/help/obsoleteFunctionsscalbln.html
|
HTML
|
bsd-2-clause
| 3,140 |
<!DOCTYPE html>
<!--
Copyright 2015 The Chromium Authors. All rights reserved.
Use of this source code is governed by a BSD-style license that can be
found in the LICENSE file.
-->
<link rel="import" href="/perf_insights/mre/function_handle.html">
<link rel="import" href="/tracing/base/math/range.html">
<link rel="import" href="/tracing/model/helpers/chrome_model_helper.html">
<script>
'use strict';
tr.exportTo('pie', function() {
// Collects the set of tasks that are preventing user input from being
// processed on the main thread.
// See https://goo.gl/l7V5xg.
function mapInputBlockers(result, model) {
var modelHelper = model.getOrCreateHelper(
tr.model.helpers.ChromeModelHelper);
var rendererHelpers = modelHelper.rendererHelpers;
if (!rendererHelpers) {
// If we didn't detect any renderer processes, bail out.
result.addPair('inputBlockers', null);
return;
}
// Look for main thread input handling in each renderer process.
var inputBlockers = {};
var foundInputBlockers = false;
for (var pid in rendererHelpers) {
var rendererHelper = rendererHelpers[pid];
var mainThread = rendererHelper.mainThread;
// Look for events that represent main thread input handling that also
// have one associated flow event showing where the input came from.
for (var event of mainThread.getDescendantEvents()) {
if (event.title !== 'LatencyInfo.Flow' ||
event.args['step'] !== 'HandleInputEventMain' ||
event.inFlowEvents.length !== 1) {
continue;
}
// Now we can derive the queueing interval from the flow event.
var flowEvent = event.inFlowEvents[0];
var queueRange =
tr.b.math.Range.fromExplicitRange(flowEvent.start, event.start);
// Find all events that intersect the queueing interval and compute how
// much they contributed to it.
for (var intersectingEvent of mainThread.getDescendantEvents()) {
var eventRange =
tr.b.math.Range.fromExplicitRange(intersectingEvent.start,
intersectingEvent.start + intersectingEvent.duration);
var intersection = queueRange.findIntersection(eventRange);
if (intersection.isEmpty || intersection.duration === 0)
continue;
if (inputBlockers[intersectingEvent.title] === undefined)
inputBlockers[intersectingEvent.title] = [];
inputBlockers[intersectingEvent.title].push(intersection.duration);
foundInputBlockers = true;
}
}
}
if (!foundInputBlockers) {
result.addPair('inputBlockers', null);
return;
}
result.addPair('inputBlockers', inputBlockers);
}
pi.FunctionRegistry.register(mapInputBlockers);
return {
mapInputBlockersForTest: mapInputBlockers
};
});
</script>
|
catapult-project/catapult
|
trace_processor/experimental/mappers/scheduling/map_input_blockers.html
|
HTML
|
bsd-3-clause
| 2,894 |
<form method="post" action="{{ integration.service_url }}">
{{ integration.generate_form.as_p }}
<input type="submit"/>
</form>
|
yceruto/merchant
|
billing/templates/billing/eway.html
|
HTML
|
bsd-3-clause
| 136 |
<!doctype html>
<html>
<title>npm-root</title>
<meta http-equiv="content-type" value="text/html;utf-8">
<link rel="stylesheet" type="text/css" href="../../static/style.css">
<link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-root.html">
<script async=true src="../../static/toc.js"></script>
<body>
<div id="wrapper">
<h1><a href="../cli/npm-root.html">npm-root</a></h1> <p>Display npm root</p>
<h2 id="synopsis">SYNOPSIS</h2>
<pre><code>npm root
</code></pre><h2 id="description">DESCRIPTION</h2>
<p>Print the effective <code>node_modules</code> folder to standard out.</p>
<h2 id="see-also">SEE ALSO</h2>
<ul>
<li><a href="../cli/npm-prefix.html">npm-prefix(1)</a></li>
<li><a href="../cli/npm-bin.html">npm-bin(1)</a></li>
<li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
<li><a href="../cli/npm-config.html">npm-config(1)</a></li>
<li><a href="../misc/npm-config.html">npm-config(7)</a></li>
<li><a href="../files/npmrc.html">npmrc(5)</a></li>
</ul>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
</table>
<p id="footer">npm-root — [email protected]</p>
|
nhanle020285/MyNodeApp
|
node_modules/meanio/node_modules/npm/html/doc/cli/npm-root.html
|
HTML
|
mit
| 3,157 |
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8"/>
<title> 有什么新的条码扫描器 </title>
<link href="../style.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<p> 新版本4.3.2： </p>
<ul>
<li> 许多小的错误修复和改进 </li>
<li> 倒白黑色条形码扫描 </li>
<li> 启用RSS扩展条码格式 </li>
<li> 从亚马逊的产品搜索结果 </li>
</ul>
<p>由谷歌翻译翻译。</p></body>
</html>
|
saurabh2590/Library-ZXING1
|
assets/html-zh-rCN/whatsnew.html
|
HTML
|
apache-2.0
| 438 |
<!doctype html><html lang=en><head><title>Redirecting…</title><link rel=canonical href=/v1.11/news/releases/0.x/announcing-0.1/><meta name=robots content="noindex"><meta charset=utf-8><meta http-equiv=refresh content="0; url=/v1.11/news/releases/0.x/announcing-0.1/"></head><body><h1>Redirecting…</h1><a href=/v1.11/news/releases/0.x/announcing-0.1/>Click here if you are not redirected.</a></body></html>
|
istio/istio.io
|
archive/v1.11/news/announcing-0.1/index.html
|
HTML
|
apache-2.0
| 415 |
<!DOCTYPE html>
<!--
Copyright 2020 The Chromium Authors. All rights reserved.
Use of this source code is governed by a BSD-style license that can be
found in the LICENSE file.
-->
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
</head>
<body>
<form method="POST">
<input type="text" id="fn" autocomplete="given-name">
<input type="text" id="ln" autocomplete="family-name">
<input type="text" id="em" autocomplete="email" value="[email protected]">
<select id="co" autocomplete="country">
<option></option>
<option value="BR">Brazil</option>
<option value="US">United States</option>
</select>
<input type="submit">
</form>
</body>
</html>
|
nwjs/chromium.src
|
components/test/data/autofill/autofill_another_element_filled.html
|
HTML
|
bsd-3-clause
| 774 |
<!--
Copyright (c) 2019 The Khronos Group Inc.
Use of this source code is governed by an MIT-style license that can be
found in the LICENSE.txt file.
-->
<!--
This file is auto-generated from py/tex_image_test_generator.py
DO NOT EDIT!
-->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<link rel="stylesheet" href="../../../resources/js-test-style.css"/>
<script src="../../../js/js-test-pre.js"></script>
<script src="../../../js/webgl-test-utils.js"></script>
<script src="../../../js/tests/tex-image-and-sub-image-utils.js"></script>
<script src="../../../js/tests/tex-image-and-sub-image-with-image-bitmap-utils.js"></script>
<script src="../../../js/tests/tex-image-and-sub-image-3d-with-image-bitmap-from-image-bitmap.js"></script>
</head>
<body>
<canvas id="example" width="32" height="32"></canvas>
<div id="description"></div>
<div id="console"></div>
<script>
"use strict";
function testPrologue(gl) {
return true;
}
generateTest("RGBA16F", "RGBA", "HALF_FLOAT", testPrologue, "../../../resources/", 2)();
</script>
</body>
</html>
|
endlessm/chromium-browser
|
third_party/webgl/src/sdk/tests/conformance2/textures/image_bitmap_from_image_bitmap/tex-3d-rgba16f-rgba-half_float.html
|
HTML
|
bsd-3-clause
| 1,059 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_22) on Mon Jan 03 13:10:07 GMT 2011 -->
<TITLE>
Line3D.LineIntersection
</TITLE>
<META NAME="date" CONTENT="2011-01-03">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Line3D.LineIntersection";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Line3D.LineIntersection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../toxi/geom/Line3D.html" title="class in toxi.geom"><B>PREV CLASS</B></A>
<A HREF="../../toxi/geom/Line3D.LineIntersection.Type.html" title="enum in toxi.geom"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?toxi/geom/Line3D.LineIntersection.html" target="_top"><B>FRAMES</B></A>
<A HREF="Line3D.LineIntersection.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
toxi.geom</FONT>
<BR>
Class Line3D.LineIntersection</H2>
<PRE>
java.lang.Object
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>toxi.geom.Line3D.LineIntersection</B>
</PRE>
<DL>
<DT><B>Enclosing class:</B><DD><A HREF="../../toxi/geom/Line3D.html" title="class in toxi.geom">Line3D</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public static class <B>Line3D.LineIntersection</B><DT>extends java.lang.Object</DL>
</PRE><map id="APIVIZ" name="APIVIZ">
<area shape="rect" id="node1" href="Line3D.LineIntersection.html" title="Line3D.LineIntersection" alt="" coords="5,6,163,34"/>
</map>
<CENTER><IMG SRC="Line3D.LineIntersection.png" USEMAP="#APIVIZ" BORDER="0"></CENTER>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../toxi/geom/Line3D.LineIntersection.Type.html" title="enum in toxi.geom">Line3D.LineIntersection.Type</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> float[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../toxi/geom/Line3D.LineIntersection.html#getCoefficients()">getCoefficients</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> float</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../toxi/geom/Line3D.LineIntersection.html#getLength()">getLength</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../toxi/geom/Line3D.html" title="class in toxi.geom">Line3D</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../toxi/geom/Line3D.LineIntersection.html#getLine()">getLine</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../toxi/geom/Line3D.LineIntersection.Type.html" title="enum in toxi.geom">Line3D.LineIntersection.Type</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../toxi/geom/Line3D.LineIntersection.html#getType()">getType</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../toxi/geom/Line3D.LineIntersection.html#isIntersectionInside()">isIntersectionInside</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../toxi/geom/Line3D.LineIntersection.html#toString()">toString</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getCoefficients()"><!-- --></A><H3>
getCoefficients</H3>
<PRE>
public float[] <B>getCoefficients</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getLength()"><!-- --></A><H3>
getLength</H3>
<PRE>
public float <B>getLength</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getLine()"><!-- --></A><H3>
getLine</H3>
<PRE>
public <A HREF="../../toxi/geom/Line3D.html" title="class in toxi.geom">Line3D</A> <B>getLine</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>the pos</DL>
</DD>
</DL>
<HR>
<A NAME="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
public <A HREF="../../toxi/geom/Line3D.LineIntersection.Type.html" title="enum in toxi.geom">Line3D.LineIntersection.Type</A> <B>getType</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>the type</DL>
</DD>
</DL>
<HR>
<A NAME="isIntersectionInside()"><!-- --></A><H3>
isIntersectionInside</H3>
<PRE>
public boolean <B>isIntersectionInside</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Line3D.LineIntersection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../toxi/geom/Line3D.html" title="class in toxi.geom"><B>PREV CLASS</B></A>
<A HREF="../../toxi/geom/Line3D.LineIntersection.Type.html" title="enum in toxi.geom"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?toxi/geom/Line3D.LineIntersection.html" target="_top"><B>FRAMES</B></A>
<A HREF="Line3D.LineIntersection.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|
aleeds/Underwater_Scene
|
libraries/toxiclibscore/docs/toxi/geom/Line3D.LineIntersection.html
|
HTML
|
mit
| 12,521 |
{% extends "logo_bar_base.html" %}
{% block page_title %}
Restricted
{% endblock %}
{% block content %}
<div class="landing-intro">
{% if before %}
<h3>You have logged in successfully, but the competition has not yet started.
The competition starts at {{ start }}, in: </h3><br/>
<h2><span id='restricted-countdown'></span>.</h2> <br/>
<h3>Come back then!</h3>
{% elif end %}
<h3>The Kukui Cup is now over. Thank you for your participation.</h3>
{% else %}
<h3>The current round of the Kukui Cup is now over. You can check the Kukui Cup <a href='http://www.facebook.com/kukuicup'>Facebook page</a> for updates. <br/> <br/>
The Kukui Cup will resume at {{ start }}, with new ways to earn points and more prizes to win. Enjoy your break!</h3>
{% endif %}
<script src="{{STATIC_URL}}js/jquery.countdown.pack.js" type="text/javascript"></script>
<script type="text/javascript">
var startDate = new Date("{{start.ctime}}");
var today = new Date();
// Calculate the number of days in the difference.
var hourDiff = (startDate - today) / (1000 * 60 * 60);
// console.log('today: ' + today + ' start: ' + startDate);
if (hourDiff > 24) {
$("#restricted-countdown").countdown({
until:startDate,
tickInterval:60,
layout:'{dn} {dl}, {hn} {hl}, and {mn} {ml}'
});
}
else {
$("#restricted-countdown").countdown({
until:startDate,
layout:'{hn} {hl}, {mn} {ml}, and {sn} {sl}'
});
}
</script>
</div>
{% endblock %}
|
yongwen/makahiki
|
makahiki/apps/widgets/home/templates/restricted.html
|
HTML
|
mit
| 1,839 |
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Blockly Demos</title>
<style>
body {
background-color: #fff;
font-family: sans-serif;
}
h1 {
font-weight: normal;
font-size: 140%;
}
dt {
margin-top: 2ex;
}
</style>
</head>
<body>
<h1><a href="https://blockly.googlecode.com/">Blockly</a> > Demos</h1>
<p>These demos are intended for developers who want to integrate Blockly with
their own applications.</p>
<dl>
<dt><a href="fixed/index.html">Fixed Blockly</a></dt>
<dd>Inject Blockly into a page as a fixed element.</dd>
<dt><a href="iframe/index.html">Resizable Blockly</a></dt>
<dd>Inject Blockly into a page as a resizable element.</dd>
<dt><a href="toolbox/index.html">Defining the Toolbox</a></dt>
<dd>Organize blocks into categories for the user.</dd>
<dt><a href="rtl/index.html">RTL</a></dt>
<dd>See what Blockly looks like in right-to-left mode (for Arabic and Hebrew).</dd>
<dt><a href="maxBlocks/index.html">Maximum Block Limit</a></dt>
<dd>Limit the total number of blocks allowed (for academic exercises).</dd>
<dt><a href="generator/index.html">Generate JavaScript</a></dt>
<dd>Turn blocks into code and execute it.</dd>
<dt><a href="interpreter/index.html">JS Interpreter</a></dt>
<dd>Step by step execution in JavaScript.</dd>
<dt><a href="storage/index.html">Cloud Storage</a></dt>
<dd>Save and load blocks with App Engine.</dd>
</dl>
</body>
</html>
|
UCSD-PL/typed-blockly
|
demos/index.html
|
HTML
|
apache-2.0
| 1,528 |
<html>
<body style="width:500px; height:750px; -webkit-column-count:2; column-count:2; column-fill:auto; -webkit-writing-mode:vertical-rl">
<h1>Header One</h1>
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nulla varius enim ac mi. Curabitur sollicitudin felis quis lectus. Quisque adipiscing rhoncus sem. Proin nulla purus, vulputate vel, varius ut, euismod et, nisi. Sed vitae felis vel orci sagittis aliquam. Cras convallis adipiscing sem. Nam nonummy enim. Nullam bibendum lobortis neque. Vestibulum velit orci, tempus euismod, pretium quis, interdum vitae, nulla. Phasellus eget ante et tortor condimentum vestibulum.
Suspendisse hendrerit quam nec felis. Sed varius turpis vitae pede. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
<h1>Header Two</h1>
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nulla varius enim ac mi. Curabitur sollicitudin felis quis lectus. Quisque adipiscing rhoncus sem. Proin nulla purus, vulputate vel, varius ut, euismod et, nisi. Sed vitae felis vel orci sagittis aliquam. Cras convallis adipiscing sem. Nam nonummy enim. Nullam bibendum lobortis neque. Vestibulum velit orci, tempus euismod, pretium quis, interdum vitae, nulla. Phasellus eget ante et tortor condimentum vestibulum.
Suspendisse hendrerit quam nec felis. Sed varius turpis vitae pede. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
<h1>Header Three</h1>
<div style="-webkit-column-count:2">
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nulla varius enim ac mi. Curabitur sollicitudin felis quis lectus. Quisque adipiscing rhoncus sem. Proin nulla purus, vulputate vel, varius ut, euismod et, nisi. Sed vitae felis vel orci sagittis aliquam. Cras convallis adipiscing sem. Nam nonummy enim. Nullam bibendum lobortis neque. Vestibulum velit orci, tempus euismod, pretium quis, interdum vitae, nulla. Phasellus eget ante et tortor condimentum vestibulum.
Suspendisse hendrerit quam nec felis. Sed varius turpis vitae pede. <span style="position:relative; opacity:0.5">Lorem ipsum dolor sit amet, consectetuer adipiscing elit.</span>
</div>
<h1>Header Four</h1>
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nulla varius enim ac mi.
</body>
</html>
|
modulexcite/blink
|
LayoutTests/fast/multicol/vertical-rl/nested-columns.html
|
HTML
|
bsd-3-clause
| 2,219 |
<!DOCTYPE html>
<!--
Copyright (c) 2013 Samsung Electronics Co., Ltd.
Licensed under the Apache License, Version 2.0 (the License);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Authors:
Karol Surma <[email protected]>
-->
<html>
<head>
<title>LocalMessagePort_isTrusted_attribute</title>
<meta charset="utf-8"/>
<script type="text/javascript" src="support/unitcommon.js"></script>
</head>
<body>
<div id="log"></div>
<script type="text/javascript">
//==== TEST: LocalMessagePort_isTrusted_attribute
//==== LABEL Check if attribute isTrusted of LocalMessagePort exists, has type boolean and is readonly
//==== SPEC Tizen Web API:IO:Messageport:LocalMessagePort:isTrusted A
//==== SPEC_URL https://developer.tizen.org/help/topic/org.tizen.web.device.apireference/tizen/messageport.html
//==== TEST_CRITERIA AE AT ARO
test(function () {
var localMsgPort = tizen.messageport.requestLocalMessagePort("localMsgPort");
assert_own_property(localMsgPort, "isTrusted", "LocalMessagePort does not own isTrusted property");
check_readonly(localMsgPort, "isTrusted", false, "boolean", true);
}, document.title);
</script>
</body>
</html>
|
xiaojunwu/crosswalk-test-suite
|
webapi/tct-messageport-tizen-tests/messageport/LocalMessagePort_isTrusted_attribute.html
|
HTML
|
bsd-3-clause
| 1,568 |
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
<script src="../../resources/js-test.js"></script>
</head>
<body>
<p id="description"></p>
<div id="console"></div>
<script src="resources/ie-test-pre.js"></script>
<script src="TestCases/15.2.3.2-2-12.js"></script>
<script src="resources/ie-test-post.js"></script>
</body>
</html>
|
modulexcite/blink
|
LayoutTests/ietestcenter/Javascript/15.2.3.2-2-12.html
|
HTML
|
bsd-3-clause
| 343 |
<!DOCTYPE html>
<!--
Copyright (c) 2013 Samsung Electronics Co., Ltd.
Licensed under the Apache License, Version 2.0 (the License);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Authors:
Andrzej Krolikowski <[email protected]>
-->
<html>
<head>
<title>RemoteMessagePort_notexist</title>
<meta charset="utf-8"/>
<script type="text/javascript" src="support/unitcommon.js"></script>
</head>
<body>
<div id="log"></div>
<script>
//==== TEST: RemoteMessagePort_notexist
//==== PRIORITY P3
//==== LABEL Check if interface RemoteMessagePort exists, it should not
//==== SPEC Tizen Web API:IO:Messageport:RemoteMessagePort:RemoteMessagePort U
//==== SPEC_URL https://developer.tizen.org/help/topic/org.tizen.web.device.apireference/tizen/messageport.html
//==== TEST_CRITERIA NIO
test(function () {
check_no_interface_object("RemoteMessagePort");
}, document.title);
</script>
</body>
</html>
|
qiuzhong/crosswalk-test-suite
|
webapi/tct-messageport-tizen-tests/messageport/RemoteMessagePort_notexist.html
|
HTML
|
bsd-3-clause
| 1,324 |
<!DOCTYPE html>
<meta charset="utf-8">
<title>Test that trial is enabled by third-party token, injected via a nested classic script</title>
<script src="../resources/testharness.js"></script>
<script src="../resources/testharnessreport.js"></script>
<script src="resources/origintrials.js"></script>
<script src="http://localhost:8000/origin_trials/resources/inject-third-party-token-nested.js"></script>
<script>
// Run tests on load, to allow for nested script to be processed.
window.onload = function () {
// The trial is enabled, by the third party token added in
// inject-third-party-token-nested.js, which is an external script, served
// from a different origin.
expect_success_third_party();
}
</script>
|
chromium/chromium
|
third_party/blink/web_tests/http/tests/origin_trials/third-party-injected-classic-script-nested.html
|
HTML
|
bsd-3-clause
| 736 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="refresh" content="0; URL=doc/html/index.html">
</head>
<body>
<p>Automatic redirection failed, please go to
<a href="doc/html/index.html">doc/html/index.html</a>.</p>
<p>Copyright Tobias Schwinger 2005-2007</p>
<p>Distributed under the Boost Software License, Version 1.0. (See accompanying file <a href="../../LICENSE_1_0.txt">
LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>).</p>
</body>
</html>
|
flingone/frameworks_base_cmds_remoted
|
libs/boost/libs/function_types/index.html
|
HTML
|
apache-2.0
| 623 |
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<title>compile-demo</title>
<script src="../../dist/template-native.js"></script>
</head>
<body>
<h1>在javascript中存放模板</h1>
<div id="content"></div>
<script>
var source = '<ul>'
+ '<% for (var i = 0; i < list.length; i ++) { %>'
+ '<li>索引 <%= i + 1 %> ：<%= list[i] %></li>'
+ '<% } %>'
+ '</ul>';
var render = template.compile(source);
var html = render({
list: ['摄影', '电影', '民谣', '旅行', '吉他']
});
document.getElementById('content').innerHTML = html;
</script>
</body>
</html>
|
WTXGBG/loltpc
|
tp5/public/assets/libs/art-template/demo/template-native/compile.html
|
HTML
|
apache-2.0
| 585 |
<!DOCTYPE html>
<meta charset="UTF-8">
<title>CSS Values and Units Test: calc() function with angle values</title>
<!--
Original test is:
https://chromium.googlesource.com/chromium/src/+/c825d655f6aaf73484f9d56e9012793f5b9668cc/third_party/WebKit/LayoutTests/css3/calc/calc-with-time-angle-and-frequency-values.html
Issue 917718: [css-values] calc-with-time-angle-and-frequency-values
test is highly unreliable, transition-delay testing causes side effects
https://bugs.chromium.org/p/chromium/issues/detail?id=917718
-->
<link rel="author" title="Gérard Talbot" href="http://www.gtalbot.org/BrowserBugsSection/css21testsuite/">
<link rel="help" href="https://www.w3.org/TR/css-values-3/#calc-computed-value">
<link rel="help" href="https://www.w3.org/TR/css-values-3/#angles">
<meta content="This test checks that additions, subtractions, multiplications and divisions in calc() function when applied to angle units." name="assert">
<script src="/resources/testharness.js"></script>
<script src="/resources/testharnessreport.js"></script>
<script src="/css/support/computed-testcommon.js"></script>
<div id="log"></div>
<div id="target"></div>
<script>
function startTesting()
{
/*
In this mega-test of 27 sub-tests, we intentionally
set the tolerance precision (epsilon) to a rather big
value (0.0001 === 100 millionths). The reason for this
is we want to verify if browsers and CSS-capable
applications do the right calculations. We do not want
to penalize browsers and CSS-capable applications that
have modest precision (not capable of a 1 millionth
level precision).
*/
// testTransformValuesCloseTo(property_name, calcValue, epsilon, expectedValue, description)
testTransformValuesCloseTo("rotate(calc(45deg + 45deg))", 0.0001, "rotate(90deg)", "addition of 2 angle units: deg plus deg");
testTransformValuesCloseTo("rotate(calc(45deg + 1rad))", 0.0001, "rotate(102.29578deg)", "addition of 2 angle units: deg plus rad");
/*
1 radian == 57.295779513 degrees
The original test was using the slightly imprecise rotate(102.3deg)
*/
testTransformValuesCloseTo("rotate(calc(20deg + 200grad))", 0.0001, "rotate(200deg)", "addition of 2 angle units: deg plus grad");
testTransformValuesCloseTo("rotate(calc(200deg + 0.5turn))", 0.0001, "rotate(380deg)", "addition of 2 angle units: deg plus turn");
testTransformValuesCloseTo("rotate(calc(45rad + 45rad))", 0.0001, "rotate(90rad)", "addition of 2 angle units: rad plus rad");
testTransformValuesCloseTo("rotate(calc(1rad + 40grad))", 0.0001, "rotate(93.29578deg)", "addition of 2 angle units: rad plus grad");
// 1 radian == 57.295779513 degrees; 40 gradians is 36 degrees.
testTransformValuesCloseTo("rotate(calc(1rad + 0.5turn))", 0.0001, "rotate(237.29578deg)", "addition of 2 angle units: rad plus turn");
testTransformValuesCloseTo("rotate(calc(45grad + 45grad))", 0.0001, "rotate(90grad)", "addition of 2 angle units: grad plus grad");
testTransformValuesCloseTo("rotate(calc(10grad + 0.5turn))", 0.0001, "rotate(189deg)", "addition of 2 angle units: grad plus turn");
// 10 gradians is 9 degrees.
// subtraction of angle unit
testTransformValuesCloseTo("rotate(calc(45deg - 15deg))", 0.0001, "rotate(30deg)", "subtraction of angle unit: deg minus deg");
testTransformValuesCloseTo("rotate(calc(90deg - 1rad))", 0.0001, "rotate(32.70422deg)", "subtraction of angle unit: deg minus rad");
// 1 radian == 57.295779513 degrees
testTransformValuesCloseTo("rotate(calc(38deg - 20grad))", 0.0001, "rotate(20deg)", "subtraction of angle unit: deg minus grad");
testTransformValuesCloseTo("rotate(calc(360deg - 0.5turn))", 0.0001, "rotate(180deg)", "subtraction of angle unit: deg minus turn");
testTransformValuesCloseTo("rotate(calc(45rad - 15rad))", 0.0001, "rotate(30rad)", "subtraction of angle unit: rad minus rad");
testTransformValuesCloseTo("rotate(calc(30rad - 10grad))", 0.0001, "rotate(1709.87339deg)", "subtraction of angle unit: rad minus grad");
// 30 radians is 1718.8733854 degrees ; 10 gradians is 9 degrees.
testTransformValuesCloseTo("rotate(calc(4rad - 0.1turn))", 0.0001, "rotate(193.18312deg)", "subtraction of angle unit: rad minus turn");
// 4 radians is 229.183118052 degrees ; 0.1 turn is 36 degrees.
testTransformValuesCloseTo("rotate(calc(45grad - 15grad))", 0.0001, "rotate(30grad)", "subtraction of angle unit: grad minus grad");
testTransformValuesCloseTo("rotate(calc(100grad - 0.25turn))", 0.0001, "rotate(0deg)", "subtraction of angle unit: grad minus turn");
// Multiplication of angle unit
testTransformValuesCloseTo("rotate(calc(45deg * 2))", 0.0001, "rotate(90deg)", "multiplication of angle unit: deg multiplied by int");
testTransformValuesCloseTo("rotate(calc(2 * 45rad))", 0.0001, "rotate(90rad)", "multiplication of angle unit: int multiplied by rad");
testTransformValuesCloseTo("rotate(calc(45grad * 2))", 0.0001, "rotate(90grad)", "multiplication of angle unit: grad multiplied by int");
testTransformValuesCloseTo("rotate(calc(2 * 45turn))", 0.0001, "rotate(90turn)", "multiplication of angle unit: int multiplied by turn");
// Division of angle unit
testTransformValuesCloseTo( "rotate(calc(90deg / 2))", 0.0001, "rotate(45deg)", "division of angle unit: deg divided by int");
testTransformValuesCloseTo("rotate(calc(90rad / 2))", 0.0001, "rotate(45rad)", "division of angle unit: rad divided by int");
testTransformValuesCloseTo("rotate(calc(90grad / 2))", 0.0001, "rotate(45grad)", "division of angle unit: grad divided by int");
testTransformValuesCloseTo("rotate(calc(90turn / 2))", 0.0001, "rotate(45turn)", "division of angle unit: turn divided by int");
/*
deg
Degrees. There are 360 degrees in a full circle.
grad
Gradians, also known as "gons" or "grades". There are 400 gradians in a full circle.
rad
Radians. There are 2π radians in a full circle.
1rad == 57.295779513°
https://www.rapidtables.com/convert/number/radians-to-degrees.html
π == Math.PI == 3.141592653589793
turn
Turns. There is 1 turn in a full circle.
*/
// Testing conversion of angle unit
testTransformValuesCloseTo("rotate(calc(50grad)", 0.0001, "rotate(45deg)", "conversion of angle unit: grad into deg");
}
startTesting();
</script>
|
chromium/chromium
|
third_party/blink/web_tests/external/wpt/css/css-values/calc-angle-values.html
|
HTML
|
bsd-3-clause
| 6,496 |
<!DOCTYPE html>
<script src="full-screen-test.js"></script>
<script>
function runTest() {
document.offsetWidth;
frame.contentDocument.offsetWidth;
var videoEnteredFullScreen = function() {
test("getComputedStyle(ancestor).position == 'static'");
endTest();
};
waitForEvent(frame.contentDocument, "webkitfullscreenchange", videoEnteredFullScreen);
test("getComputedStyle(ancestor).position == 'relative'");
runWithKeyDown(function(){
frame.contentDocument.querySelector("video").webkitRequestFullScreen();
});
}
</script>
<div id="ancestor" style="position:relative">
<iframe allowfullscreen id="frame" src="data:text/html,<video></video>" onload="runTest()"></iframe>
</div>
|
danakj/chromium
|
third_party/WebKit/LayoutTests/fullscreen/full-screen-iframe-ua-style.html
|
HTML
|
bsd-3-clause
| 789 |
<!DOCTYPE html>
<title>Same-origin prerendering can access localStorage</title>
<meta name="timeout" content="long">
<script src="/resources/testharness.js"></script>
<script src="/resources/testharnessreport.js"></script>
<script src="/common/utils.js"></script>
<script src="/common/dispatcher/dispatcher.js"></script>
<script src="resources/utils.js"></script>
<body>
<script>
setup(() => assertSpeculationRulesIsSupported());
promise_test(async t => {
const {exec, activate} = await create_prerendered_page(t);
const workerURL = new URL('resources/worker-post-timeOrigin.js', location.href).toString();
await exec(workerURL => {
window.worker = new Worker(workerURL);
window.waitForWorker = new Promise(resolve => worker.addEventListener('message', e => {
resolve({
prerendering: document.prerendering,
activationStart: performance.getEntriesByType('navigation')[0].activationStart,
workerLoad: performance.getEntriesByName(workerURL)[0].startTime,
workerStart: e.data});
}), workerURL);
}, workerURL);
// We want to prevent false success by waiting for enough time to make sure the worker is not
// yet initialized
await new Promise(resolve => t.step_timeout(resolve, 500));
await activate();
const {workerStart, activationStart, workerLoad, prerendering } = await exec(() => window.waitForWorker);
assert_equals(prerendering, false);
assert_greater_than(activationStart, workerLoad, "Loading the worker script should not be delayed");
assert_greater_than(workerStart, activationStart, "Starting the worker should be delayed");
}, "Dedicated workers should be loaded in suspended state until activated");
promise_test(async t => {
const {exec, activate} = await create_prerendered_page(t);
const workerURL = new URL(`resources/shared-worker.py?id=${token()}`, location.href).toString();
await exec(workerURL => {
window.worker = new SharedWorker(workerURL, 'dummy');
window.worker.port.start();
window.waitForSharedWorkerLoadingReport =
fetch(workerURL + "&check=true")
.then(r => t.text())
.then(text => text === 'ok' && document.prerendering);
window.waitForWorker = new Promise(resolve => worker.port.addEventListener('message', e => {
resolve({
prerendering: document.prerendering,
activationStart: performance.getEntriesByType('navigation')[0].activationStart,
workerStart: e.data});
}), workerURL);
}, workerURL);
await new Promise(resolve => t.step_timeout(resolve, 300));
await activate();
const {workerStart, activationStart, workerLoad, prerendering } = await exec(() => window.waitForWorker);
const loadedWhilePrerendering = await exec(() => window.loadedWhilePrerendering);
assert_true(loadedWhilePrerendering, "The shared worker should be loaded (but suspended) while prerendering");
assert_false(prerendering, "SharedWorker should be suspended until activated");
assert_greater_than(workerStart, activationStart, "Starting the worker should be delayed");
// TODO: check SharedWorker loading. This is not yet possible due to SharedWorkers not reporting timing.
}, "Shared workers should be loaded in suspended state until activated");
promise_test(async t => {
const {exec, activate} = await create_prerendered_page(t);
const workerURL = new URL(`resources/shared-worker.py?id=${token()}`, location.href).toString();
const workerStartTime1 = await new Promise(resolve => {
const worker = new SharedWorker(workerURL, 'worker');
worker.port.start();
worker.port.addEventListener('message', e => resolve(e.data));
});
await exec(workerURL => {
window.worker = new SharedWorker(workerURL, 'worker');
window.worker.port.start();
window.waitForWorker = new Promise(resolve => worker.port.addEventListener('message', e => {
resolve({
prerendering: document.prerendering,
activationStart: performance.getEntriesByType('navigation')[0].activationStart,
workerStartTime2: e.data});
}), workerURL);
}, workerURL);
await new Promise(resolve => t.step_timeout(resolve, 300));
await activate();
const {workerStartTime2, activationStart, workerLoad, prerendering } = await exec(() => window.waitForWorker);
assert_true(prerendering, "An existing SharedWorker should be accessible while prerendering");
assert_equals(workerStartTime1, workerStartTime2);
assert_greater_than(workerStart, activationStart, "Starting the worker should be delayed");
}, "Existing shared workers should be accessible before activation");
</script>
</body>
|
chromium/chromium
|
third_party/blink/web_tests/external/wpt/speculation-rules/prerender/workers.html
|
HTML
|
bsd-3-clause
| 4,623 |
<!DOCTYPE html>
<style>
body {
height: 2000px;
margin: 0;
overflow: hidden;
padding: 0;
}
.sticky {
width: 200px;
height: 200px;
background-color: green;
display: inline-block;
position: sticky;
top: 0;
}
.block {
width: 200px;
height: 200px;
background-color: red;
}
</style>
<script>
function doTest()
{
window.scrollTo(0, 200);
}
window.addEventListener('load', doTest, false);
</script>
<span class="sticky"></span>
<div class="block"></div>
|
scheib/chromium
|
third_party/blink/web_tests/fast/css/sticky/inline-sticky-anonymous-container.html
|
HTML
|
bsd-3-clause
| 503 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<title>Index of /2009/sparql/docs/tests/data-sparql11/entailment-RDF</title>
</head>
<body>
<h1>Index of /2009/sparql/docs/tests/data-sparql11/entailment-RDF</h1>
<table><tr><th><img src="/icons/blank.gif" alt="[ICO]"></th><th>Name</th><th>Last modified</th><th>Size</th><th>Description</th></tr><tr><th colspan="5"><hr></th></tr>
<tr><td valign="top"><img src="/icons/back.gif" alt="[DIR]"></td><td><a href="/2009/sparql/docs/tests/data-sparql11/">Parent Directory</a></td><td> </td><td align="right"> - </td><td> </td></tr>
<tr><th colspan="5"><hr></th></tr>
</table>
</body></html>
|
clarkparsia/ontop
|
quest-test/src/main/resources/testcases-dawg-sparql-1.1/entailment-RDF/index.html
|
HTML
|
apache-2.0
| 671 |
<header>½s¿è®M¥ó</header>
³o¤@¶Åã¥Ü¥XÃö©ó¤@Ó¤w¦w¸Ë®M¥óªº¬ÛÃö¸ê°T. <tt>¦C¥XÀÉ®×</tt>«ö¶s¥i¥H¦C¥X©Ò¦³³oÓ®M¥óªºÀÉ®×, <tt>¸Ñ°£¦w¸Ë</tt>«ö¶s¥i¥H§R°£³oÓ®M¥ó.
<hr>
|
rcuvgd/Webmin22.01.2016
|
software/help/edit_pack.zh_TW.Big5.html
|
HTML
|
bsd-3-clause
| 163 |
<head>
<title>Valid argument list with a vendor-specific "viewport-fit" arguments.</title>
<meta name="viewport" content="viewport-fit=cover" />
</head>
|
nwjs/chromium.src
|
third_party/blink/renderer/core/testing/data/viewport/viewport-warnings-8.html
|
HTML
|
bsd-3-clause
| 161 |
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta content="text/html; charset=UTF-8" http-equiv="CONTENT-TYPE" />
<link rel="stylesheet" href="../../book.css" type="text/css" />
<title>New BPEL Process File</title>
</head>
<body>
<h1>New BPEL Process File</h1>
<p>
The <strong>New BPEL Process File Wizard</strong> allows to create a BPEL process based on one of several
templates defined by the wizard. The wizard assumes the new BPEL
process is to be created in the currently selected project of the
<strong>Project Explorer</strong> or
<strong>Navigator</strong> view. If a BPEL
process of the same name already exists within the project, a warning
message will be displayed before any action is performed.
</p>
<p>
<img src="../../../images/reference/Create_a_BPEL_Process_File_01.png" alt="New BPEL Process" />
</p>
<p><b>New BPEL Process</b></p>
<p>The first page includes the following options:</p>
<p><b>New BPEL Process file wizard. First page options.</b></p>
<table summary="New BPEL Process file wizard. First page options." border="1">
<colgroup>
<col align="left" />
<col align="left" />
<col align="left" />
</colgroup>
<thead>
<tr>
<th align="left">Field</th>
<th align="left">Description</th>
<th align="left">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">Name</td>
<td align="left">Enter the process name.</td>
<td align="left">no default value</td>
</tr>
<tr>
<td align="left">Namespace</td>
<td align="left">Enter the namespace URL. All namespaces should
follow the W3C recommendation (<a href="http://www.w3.org/1999/10/nsuri">http://www.w3.org/1999/10/nsuri</a>).</td>
<td align="left">no default value</td>
</tr>
<tr>
<td align="left">Template</td>
<td align="left">Select one of the provided templates:
<ul>
<li><em>Asynchronous BPEL Process</em> - generates
the basis of orchestration logic: receive and reply activities
are included into the process; client WSDL is generated,
service is defined in the class="property">parentlink of the
process. The caller is notified asynchronously when the process
completes.
</li>
<li><em>Empty BPEL Process</em> - list of services
participating in this BPEL process together with the one of
messages used within the process is empty.There are no any
orchestration logic.
</li>
<li><em>Synchronous BPEL Process</em> - similar to
Asynchronous BPEL Process template except the fact that here
the caller is notified synchronously when the process
completes.
</li>
</ul>
</td>
<td align="left">Asynchronous BPEL Process</td>
</tr>
<tr>
<td align="left">Abstract Process</td>
<td align="left">Specifies the created process as an abstract
one -partially specified processes that are not intended to be executed.</td>
<td align="left">unchecked</td>
</tr>
</tbody>
</table>
<p>The second page of the wizard defines the process interface
(WSDL file) including the web service address, port definition and
protocol. The wizard will populate all of these fields with
appropriate default values based on the information provided on the
previous page.
</p>
<p>
<img src="../../../images/reference/Create_a_BPEL_Process_File_02.png" alt="New BPEL Process" />
</p>
<p><b>New BPEL Process</b></p>
<p>The second page includes the following options:</p> </a>
<p><b>New BPEL process file wizard. Second page options.</b></p>
<table summary="New BPEL process file wizard. Second page options."
border="1">
<colgroup>
<col align="left" />
<col align="left" />
<col align="left" />
</colgroup>
<thead>
<tr>
<th align="left">Field</th>
<th align="left">Description</th>
<th align="left">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">Service Name</td>
<td align="left">Enter a WDSL service name for the BPEL process.</td>
<td align="left">The process name</td>
</tr>
<tr>
<td align="left">Port Name</td>
<td align="left">Enter a WDSL port name for the BPEL process.</td>
<td align="left">The process name + 'Port'</td>
</tr>
<tr>
<td align="left">Service Address</td>
<td align="left">Enter an address of the WDSL service for the BPEL process.</td>
<td align="left">http://localhost:8080/ + process name</td>
</tr>
<tr>
<td align="left">Binding Protocol</td>
<td align="left">Choose the binding protocol that you use in the WDSL: SOAP or HTTP</td>
<td align="left">SOAP</td>
</tr>
</tbody>
</table>
<p>The final page allows you to select the target project and
folder for the new process artifacts. If a process with the name you
provided already exists in that project and folder, the wizard will
display an error message.
</p>
<p>
If the project is not a BPEL Project (does not define a BPEL facet)
the wizard will display a warning message. You can still create the
BPEL process, however it will not be deployable to a BPEL runtime
engine until the BPEL facet has been added to the project (see the <strong>Help</strong>
menu for more information about project facets).
</p>
<div style="border: solid black 1px; background-color: #ccc">
<h2>Important</h2>
<p>
BPEL artifacts must be contained somewhere within the
<code>bpelContent</code> folder hierarchy if you intend to deploy the process. Complex
projects may be organized into a folder hierarchy, but these folders must be contained within
<code>bpelContent</code>.
</p>
<p>
The <code>Deployment Descriptor</code> file must be contained within the
<code>bpelContent</code> folder and at the root of any folder hierarchy.
</p>
</div>
<p>
<img src="../../../images/reference/Create_a_BPEL_Process_File_03.png" alt="New BPEL Process" />
</p>
<p class="title"><b>New BPEL Process</b></p>
<p>You will be asked if you wish for the BPEL perspective to be opened once this wizard completes.</p>
</body>
</html>
|
Drifftr/devstudio-tooling-bps
|
plugins/org.eclipse.bpel.help/html/Reference/Wizards/newBpelProcessFile.html
|
HTML
|
apache-2.0
| 6,476 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
<TITLE>CSS1 Test Suite: 5.2.5 font-weight</TITLE>
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<META http-equiv="Content-Style-Type" content="text/css">
<LINK rel="stylesheet" type="text/css" media="screen" href="../resources/base.css">
<SCRIPT src="../resources/base.js"></SCRIPT>
<STYLE type="text/css">
.one {font-weight: bold;}
.two {font-weight: bolder;}
.three {font-weight: lighter;}
.four {font-weight: 100;}
.five {font-weight: 300;}
.six {font-weight: 500;}
.seven {font-weight: 700;}
.eight {font-weight: 900;}
.nine {font-weight: normal;}
B {font-weight: lighter;}
</STYLE>
</HEAD>
<BODY><P>The style declarations which apply to the text below are:</P>
<PRE>.one {font-weight: bold;}
.two {font-weight: bolder;}
.three {font-weight: lighter;}
.four {font-weight: 100;}
.five {font-weight: 300;}
.six {font-weight: 500;}
.seven {font-weight: 700;}
.eight {font-weight: 900;}
.nine {font-weight: normal;}
B {font-weight: lighter;}
</PRE>
<HR>
<P class="one">
This sentence should be bold.
</P>
<P class="two">
This sentence should be bolder than normal.
</P>
<H4>This is a heading-4.</H4>
<H4 class="two">This is a bolder heading-4.</H4>
<P>
<B>This sentence should be normal (boldface made lighter).</B>
</P>
<P class="four">
This sentence should be weight 100.
</P>
<P class="five">
This sentence should be weight 300.
</P>
<P class="six">
This sentence should be weight 500.
</P>
<P class="seven">
This sentence should be weight 700.
</P>
<P class="eight">
This sentence should be weight 900.
</P>
<P class="one">
This sentence should be bold, but the last word in the sentence should be <SPAN class="nine">normal</SPAN>.
</P>
<TABLE border cellspacing="0" cellpadding="3" class="tabletest">
<TR>
<TD colspan="2" bgcolor="silver"><STRONG>TABLE Testing Section</STRONG></TD>
</TR>
<TR>
<TD bgcolor="silver"> </TD>
<TD><P class="one">
This sentence should be bold.
</P>
<P class="two">
This sentence should be bolder than normal.
</P>
<H4>This is a heading-4.</H4>
<H4 class="two">This is a bolder heading-4.</H4>
<P>
<B>This sentence should be normal (boldface made lighter).</B>
</P>
<P class="four">
This sentence should be weight 100.
</P>
<P class="five">
This sentence should be weight 300.
</P>
<P class="six">
This sentence should be weight 500.
</P>
<P class="seven">
This sentence should be weight 700.
</P>
<P class="eight">
This sentence should be weight 900.
</P>
<P class="one">
This sentence should be bold, but the last word in the sentence should be <SPAN class="nine">normal</SPAN>.
</P>
</TD></TR></TABLE></BODY>
</HTML>
|
scheib/chromium
|
third_party/blink/web_tests/css1/font_properties/font_weight.html
|
HTML
|
bsd-3-clause
| 2,717 |
{% extends "manage/manage_base.html" %}
{% set page = "picturegallery" %}
{% block manage_title %}
Upload pictures
{% endblock %}
{% block site_css %}
{{ super() }}
<link href="{{ static('dropzone/css/dropzone.css') }}" rel="stylesheet" type="text/css">
{% endblock %}
{% block site_js %}
{{ super() }}
<script src="{{ static('dropzone/dropzone.min.js') }}"></script>
{% compress js %}
<script src="{{ static('manage/js/picture-add.js') }}"></script>
{% endcompress %}
{% endblock %}
{% block manage_content %}
<form action="." method="post" enctype="multipart/form-data"
id="picture-dropzone" class="dropzone">
{{ csrf() }}
</form>
<p>
When you're done
<a href="{{ url('manage:picturegallery') }}{% if event %}?event={{ event.id }}{% endif %}"
>go back to the Picture Gallery</a>
</p>
{% endblock %}
|
ehsan/airmozilla
|
airmozilla/manage/templates/manage/picture_add.html
|
HTML
|
bsd-3-clause
| 845 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="shortcut icon" type="image/ico" href="http://www.sprymedia.co.uk/media/images/favicon.ico">
<title>FixedColumns example</title>
<style type="text/css" title="currentStyle">
@import "../../media/css/demo_page.css";
@import "../../media/css/demo_table.css";
tr { height: 50px; }
</style>
<script type="text/javascript" charset="utf-8" src="../../media/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../media/js/jquery.dataTables.js"></script>
<script type="text/javascript" charset="utf-8" src="media/js/FixedColumns.js"></script>
<script type="text/javascript" charset="utf-8">
$(document).ready( function () {
var iStart = new Date().getTime();
var oTable = $('#example').dataTable( {
"sScrollY": "300px",
"sScrollX": "100%",
"sScrollXInner": "150%",
"bScrollCollapse": true,
"bPaginate": false
} );
new FixedColumns( oTable, {
"sHeightMatch": "none"
} );
} );
</script>
</head>
<body id="dt_example">
<div id="container">
<div class="full_width big">
FixedColumns example - CSS row sizing
</div>
<h1>Preamble</h1>
<p>Because of the method FixedColumns uses to display the fixed columns, an important consideration is the alignment of the rows due to different heights in the individual rows of the table. There are two different algorithms in FixedColumns which can be used, or you can switch off automatic row sizing all together. This is controlled through the <i>sHeightMatch</i> parameter. If can take the following values:</p>
<ul>
<li>"none" - no automatic row height matching is performed. CSS can be used in this case and is useful when speed is of primary importance.</li>
<li>"semiauto" (default) - the height calculation will be performed once, and the result cached to be used again (fnRecalculateHeight can be used to force recalculation)</li>
<li>"auto" - height matching is performed on every draw (slowest but must accurate)</li>
</ul>
<p>This example shows row height matching switched off but there is a CSS statement of tr { height: 50px } to force all rows to the same height.</p>
<h1>Live example</h1>
<div id="demo">
<table class="display" id="example">
<thead>
<tr>
<th>Rendering engine</th>
<th>Browser</th>
<th>Platform(s)</th>
<th>Engine version</th>
<th>CSS grade</th>
</tr>
</thead>
<tfoot>
<tr>
<th>Rendering engine</th>
<th>Browser</th>
<th>Platform(s)</th>
<th>Engine version</th>
<th>CSS grade</th>
</tr>
</tfoot>
<tbody>
<tr class="gradeX">
<td>Trident</td>
<td>Internet
Explorer 4.0</td>
<td>Win 95+</td>
<td class="center">4</td>
<td class="center">X</td>
</tr>
<tr class="gradeC">
<td>Trident</td>
<td>Internet
Explorer 5.0</td>
<td>Win 95+</td>
<td class="center">5</td>
<td class="center">C</td>
</tr>
<tr class="gradeA">
<td>Trident</td>
<td>Internet
Explorer 5.5</td>
<td>Win 95+</td>
<td class="center">5.5</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Trident</td>
<td>Internet
Explorer 6</td>
<td>Win 98+</td>
<td class="center">6</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Trident</td>
<td>Internet Explorer 7</td>
<td>Win XP SP2+</td>
<td class="center">7</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Trident</td>
<td>AOL browser (AOL desktop)</td>
<td>Win XP</td>
<td class="center">6</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Firefox 1.0</td>
<td>Win 98+ / OSX.2+</td>
<td class="center">1.7</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Firefox <br>1.5</td>
<td>Win 98+ / OSX.2+</td>
<td class="center">1.8</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Firefox 2.0</td>
<td>Win 98+ / OSX.2+</td>
<td class="center">1.8</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Firefox 3.0</td>
<td>Win 2k+ / OSX.3+</td>
<td class="center">1.9</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Camino 1.0</td>
<td>OSX.2+</td>
<td class="center">1.8</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Camino 1.5</td>
<td>OSX.3+</td>
<td class="center">1.8</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Netscape 7.2</td>
<td>Win 95+ / Mac OS 8.6-9.2</td>
<td class="center">1.7</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Netscape Browser 8</td>
<td>Win 98SE+</td>
<td class="center">1.7</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Netscape Navigator 9</td>
<td>Win 98+ / OSX.2+</td>
<td class="center">1.8</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Mozilla 1.0</td>
<td>Win 95+ / OSX.1+</td>
<td class="center">1</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Mozilla 1.1</td>
<td>Win 95+ / OSX.1+</td>
<td class="center">1.1</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Mozilla 1.2</td>
<td>Win 95+ / OSX.1+</td>
<td class="center">1.2</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Mozilla 1.3</td>
<td>Win 95+ / OSX.1+</td>
<td class="center">1.3</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Mozilla 1.4</td>
<td>Win 95+ / OSX.1+</td>
<td class="center">1.4</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Mozilla 1.5</td>
<td>Win 95+ / OSX.1+</td>
<td class="center">1.5</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Mozilla 1.6</td>
<td>Win 95+ / OSX.1+</td>
<td class="center">1.6</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Mozilla 1.7</td>
<td>Win 98+ / OSX.1+</td>
<td class="center">1.7</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Mozilla 1.8</td>
<td>Win 98+ / OSX.1+</td>
<td class="center">1.8</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Seamonkey 1.1</td>
<td>Win 98+ / OSX.2+</td>
<td class="center">1.8</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Gecko</td>
<td>Epiphany 2.20</td>
<td>Gnome</td>
<td class="center">1.8</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Webkit</td>
<td>Safari 1.2</td>
<td>OSX.3</td>
<td class="center">125.5</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Webkit</td>
<td>Safari 1.3</td>
<td>OSX.3</td>
<td class="center">312.8</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Webkit</td>
<td>Safari 2.0</td>
<td>OSX.4+</td>
<td class="center">419.3</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Webkit</td>
<td>Safari 3.0</td>
<td>OSX.4+</td>
<td class="center">522.1</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Webkit</td>
<td>OmniWeb 5.5</td>
<td>OSX.4+</td>
<td class="center">420</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Webkit</td>
<td>iPod Touch / iPhone</td>
<td>iPod</td>
<td class="center">420.1</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Webkit</td>
<td>S60</td>
<td>S60</td>
<td class="center">413</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Presto</td>
<td>Opera 7.0</td>
<td>Win 95+ / OSX.1+</td>
<td class="center">-</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Presto</td>
<td>Opera 7.5</td>
<td>Win 95+ / OSX.2+</td>
<td class="center">-</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Presto</td>
<td>Opera 8.0</td>
<td>Win 95+ / OSX.2+</td>
<td class="center">-</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Presto</td>
<td>Opera 8.5</td>
<td>Win 95+ / OSX.2+</td>
<td class="center">-</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Presto</td>
<td>Opera 9.0</td>
<td>Win 95+ / OSX.3+</td>
<td class="center">-</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Presto</td>
<td>Opera 9.2</td>
<td>Win 88+ / OSX.3+</td>
<td class="center">-</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Presto</td>
<td>Opera 9.5</td>
<td>Win 88+ / OSX.3+</td>
<td class="center">-</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Presto</td>
<td>Opera for Wii</td>
<td>Wii</td>
<td class="center">-</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Presto</td>
<td>Nokia N800</td>
<td>N800</td>
<td class="center">-</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>Presto</td>
<td>Nintendo DS browser</td>
<td>Nintendo DS</td>
<td class="center">8.5</td>
<td class="center">C/A</td>
</tr>
<tr class="gradeC">
<td>KHTML</td>
<td>Konqureror 3.1</td>
<td>KDE 3.1</td>
<td class="center">3.1</td>
<td class="center">C</td>
</tr>
<tr class="gradeA">
<td>KHTML</td>
<td>Konqureror 3.3</td>
<td>KDE 3.3</td>
<td class="center">3.3</td>
<td class="center">A</td>
</tr>
<tr class="gradeA">
<td>KHTML</td>
<td>Konqureror 3.5</td>
<td>KDE 3.5</td>
<td class="center">3.5</td>
<td class="center">A</td>
</tr>
<tr class="gradeX">
<td>Tasman</td>
<td>Internet Explorer 4.5</td>
<td>Mac OS 8-9</td>
<td class="center">-</td>
<td class="center">X</td>
</tr>
<tr class="gradeC">
<td>Tasman</td>
<td>Internet Explorer 5.1</td>
<td>Mac OS 7.6-9</td>
<td class="center">1</td>
<td class="center">C</td>
</tr>
<tr class="gradeC">
<td>Tasman</td>
<td>Internet Explorer 5.2</td>
<td>Mac OS 8-X</td>
<td class="center">1</td>
<td class="center">C</td>
</tr>
<tr class="gradeA">
<td>Misc</td>
<td>NetFront 3.1</td>
<td>Embedded devices</td>
<td class="center">-</td>
<td class="center">C</td>
</tr>
<tr class="gradeA">
<td>Misc</td>
<td>NetFront 3.4</td>
<td>Embedded devices</td>
<td class="center">-</td>
<td class="center">A</td>
</tr>
<tr class="gradeX">
<td>Misc</td>
<td>Dillo 0.8</td>
<td>Embedded devices</td>
<td class="center">-</td>
<td class="center">X</td>
</tr>
<tr class="gradeX">
<td>Misc</td>
<td>Links</td>
<td>Text only</td>
<td class="center">-</td>
<td class="center">X</td>
</tr>
<tr class="gradeX">
<td>Misc</td>
<td>Lynx</td>
<td>Text only</td>
<td class="center">-</td>
<td class="center">X</td>
</tr>
<tr class="gradeC">
<td>Misc</td>
<td>IE Mobile</td>
<td>Windows Mobile 6</td>
<td class="center">-</td>
<td class="center">C</td>
</tr>
<tr class="gradeC">
<td>Misc</td>
<td>PSP browser</td>
<td>PSP</td>
<td class="center">-</td>
<td class="center">C</td>
</tr>
<tr class="gradeU">
<td>Other browsers</td>
<td>All others</td>
<td>-</td>
<td class="center">-</td>
<td class="center">U</td>
</tr>
</tbody>
</table>
</div>
<div class="spacer"></div>
<h1>Initialisation code</h1>
<pre>$(document).ready( function () {
var oTable = $('#example').dataTable( {
"sScrollX": "100%",
"sScrollXInner": "150%",
"bScrollCollapse": true
} );
new FixedColumns( oTable );
} );</pre>
<h1>Documentation</h1>
<ul>
<li><a href="http://datatables.net/extras/fixedcolumns">Usage</a></li>
<li><a href="http://datatables.net/docs/FixedColumns">API / parameters</a></li>
</ul>
<h1>Basic examples</h1>
<ul>
<li><a href="index.html">Basic demo of FixedColumns with zero initialisation</a></li>
<li><a href="left_right_columns.html">Fix the left and right columns in place</a></li>
<li><a href="index_column.html">Index column attached to side of the table</a></li>
<li><a href="x_y_scrolling.html">Index column, but with Y scrolling and no pagination</a></li>
<li><a href="two_columns.html">Two columns fixed in place</a></li>
<li><a href="right_column.html">Fix the right column in place</a></li>
<li><a href="css_size.html">Speeding up row height matching with CSS</a></li>
<li><a href="themed.html">jQuery UI themed table with FixedColumns</a></li>
</ul>
<h1>Advanced examples</h1>
<ul>
<li><a href="rowspan.html">Using ROWSPAN with FixedColumns</a></li>
<li><a href="server-side-processing.html">Server-side processing with FixedColumns</a></li>
<li><a href="col_filter.html">Individual column filtering</a></li>
<li><a href="scale_fixed.html">Setting the fixed column width and resizing the table</a></li>
<li><a href="scale_relative.html">Setting the fixed column width with relative sizing</a></li>
<li><a href="row_grouping_height.html">Row grouping by grouping like rows in the fixed column</a></li>
<li><a href="row_grouping.html">Row grouping by inserting a grouping row</a></li>
<ul>
<div id="footer" style="text-align:center;">
<span style="font-size:10px;">
FixedColumns and DataTables © Allan Jardine 2011.<br>
</span>
</div>
</div>
</body>
</html>
|
Adriwr/Clinica
|
web/css/vendor/plugins/datatables/dynamic/extras/FixedColumns/css_size.html
|
HTML
|
mit
| 13,886 |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Thelia\Model\Base\CouponI18n | Thelia 2 API</title>
<link rel="stylesheet" type="text/css" href="../../../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../../../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../../../css/sami.css">
<script src="../../../js/jquery-1.11.1.min.js"></script>
<script src="../../../js/bootstrap.min.js"></script>
<script src="../../../js/typeahead.min.js"></script>
<script src="../../../sami.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="class" data-name="class:Thelia_Model_Base_CouponI18n" data-root-path="../../../">
<div id="content">
<div id="left-column">
<div id="control-panel">
<form id="search-form" action="../../../search.html" method="GET">
<span class="glyphicon glyphicon-search"></span>
<input name="search"
class="typeahead form-control"
type="search"
placeholder="Search">
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../../index.html">Thelia 2 API</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../../../classes.html">Classes</a></li>
<li><a href="../../../namespaces.html">Namespaces</a></li>
<li><a href="../../../interfaces.html">Interfaces</a></li>
<li><a href="../../../traits.html">Traits</a></li>
<li><a href="../../../doc-index.html">Index</a></li>
<li><a href="../../../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">class</span></li>
<li><a href="../../../Thelia.html">Thelia</a></li>
<li><a href="../../../Thelia/Model.html">Model</a></li>
<li><a href="../../../Thelia/Model/Base.html">Base</a></li>
<li>CouponI18n</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>CouponI18n</h1>
</div>
<p> class
<strong>CouponI18n</strong> implements
<abbr title="Propel\Runtime\ActiveRecord\ActiveRecordInterface">ActiveRecordInterface</abbr>
</p>
<h2>Constants</h2>
<table class="table table-condensed">
<tr>
<td>TABLE_MAP</td>
<td class="last">
<p><em>TableMap class name</em></p>
<p></p>
</td>
</tr>
</table>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_applyDefaultValues">applyDefaultValues</a>()
<p>Applies default values to this object.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method___construct">__construct</a>()
<p>Initializes internal state of Thelia\Model\Base\CouponI18n object.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
boolean
</div>
<div class="col-md-8 type">
<a href="#method_isModified">isModified</a>()
<p>Returns whether the object has been modified.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
boolean
</div>
<div class="col-md-8 type">
<a href="#method_isColumnModified">isColumnModified</a>(
string $col)
<p>Has specified column been modified?</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_getModifiedColumns">getModifiedColumns</a>()
<p>Get the columns that have been modified in this object.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
boolean
</div>
<div class="col-md-8 type">
<a href="#method_isNew">isNew</a>()
<p>Returns whether the object has ever been saved. This will
be false, if the object was retrieved from storage or was created
and then saved.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_setNew">setNew</a>(
boolean $b)
<p>Setter for the isNew attribute. This method will be called
by Propel-generated children and objects.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
boolean
</div>
<div class="col-md-8 type">
<a href="#method_isDeleted">isDeleted</a>()
<p>Whether this object has been deleted.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
void
</div>
<div class="col-md-8 type">
<a href="#method_setDeleted">setDeleted</a>(
boolean $b)
<p>Specify whether this object has been deleted.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
void
</div>
<div class="col-md-8 type">
<a href="#method_resetModified">resetModified</a>(
string $col = null)
<p>Sets the modified state for the object to be false.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
boolean
</div>
<div class="col-md-8 type">
<a href="#method_equals">equals</a>(
mixed $obj)
<p>Compares this with another <code>CouponI18n</code> instance. If
<code>obj</code> is an instance of <code>CouponI18n</code>, delegates to
<code>equals(CouponI18n)</code>. Otherwise, returns <code>false</code>.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
int
</div>
<div class="col-md-8 type">
<a href="#method_hashCode">hashCode</a>()
<p>If the primary key is not null, return the hashcode of the
primary key. Otherwise, return the hash code of the object.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_getVirtualColumns">getVirtualColumns</a>()
<p>Get the associative array of the virtual columns in this object</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
boolean
</div>
<div class="col-md-8 type">
<a href="#method_hasVirtualColumn">hasVirtualColumn</a>(
string $name)
<p>Checks the existence of a virtual column in this object</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
mixed
</div>
<div class="col-md-8 type">
<a href="#method_getVirtualColumn">getVirtualColumn</a>(
string $name)
<p>Get the value of a virtual column in this object</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../../Thelia/Model/Base/CouponI18n.html"><abbr title="Thelia\Model\Base\CouponI18n">CouponI18n</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setVirtualColumn">setVirtualColumn</a>(
string $name,
mixed $value)
<p>Set the value of a virtual column in this object</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../../Thelia/Model/Base/CouponI18n.html"><abbr title="Thelia\Model\Base\CouponI18n">CouponI18n</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_importFrom">importFrom</a>(
mixed $parser,
string $data)
<p>Populate the current object from a string, using a given parser format
<code>
$book = new Book();
$book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
</code></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_exportTo">exportTo</a>(
mixed $parser,
boolean $includeLazyLoadColumns = true)
<p>Export the current object properties to a string, using a given parser format
<code>
$book = BookQuery::create()->findPk(9012);
echo $book->exportTo('JSON');
=> {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
</code></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method___sleep">__sleep</a>()
<p>Clean up internal collections prior to serializing
Avoids recursive loops that turn into segmentation faults when serializing</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
int
</div>
<div class="col-md-8 type">
<a href="#method_getId">getId</a>()
<p>Get the [id] column value.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getLocale">getLocale</a>()
<p>Get the [locale] column value.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getTitle">getTitle</a>()
<p>Get the [title] column value.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getShortDescription">getShortDescription</a>()
<p>Get the [short_description] column value.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getDescription">getDescription</a>()
<p>Get the [description] column value.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setId">setId</a>(
int $v)
<p>Set the value of [id] column.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setLocale">setLocale</a>(
string $v)
<p>Set the value of [locale] column.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setTitle">setTitle</a>(
string $v)
<p>Set the value of [title] column.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setShortDescription">setShortDescription</a>(
string $v)
<p>Set the value of [short_description] column.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setDescription">setDescription</a>(
string $v)
<p>Set the value of [description] column.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
boolean
</div>
<div class="col-md-8 type">
<a href="#method_hasOnlyDefaultValues">hasOnlyDefaultValues</a>()
<p>Indicates whether the columns in this object are only set to default values.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
int
</div>
<div class="col-md-8 type">
<a href="#method_hydrate">hydrate</a>(
array $row,
int $startcol,
boolean $rehydrate = false,
string $indexType = TableMap::TYPE_NUM)
<p>Hydrates (populates) the object variables with values from the database resultset.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_ensureConsistency">ensureConsistency</a>()
<p>Checks and repairs the internal consistency of the object.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
void
</div>
<div class="col-md-8 type">
<a href="#method_reload">reload</a>(
boolean $deep = false,
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)
<p>Reloads this object from datastore based on primary key and (optionally) resets all associated objects.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
void
</div>
<div class="col-md-8 type">
<a href="#method_delete">delete</a>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)
<p>Removes this object from datastore and sets delete attribute.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
int
</div>
<div class="col-md-8 type">
<a href="#method_save">save</a>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)
<p>Persists this object to the database.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
mixed
</div>
<div class="col-md-8 type">
<a href="#method_getByName">getByName</a>(
string $name,
string $type = TableMap::TYPE_PHPNAME)
<p>Retrieves a field from the object by name passed in as a string.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
mixed
</div>
<div class="col-md-8 type">
<a href="#method_getByPosition">getByPosition</a>(
int $pos)
<p>Retrieves a field from the object by Position as specified in the xml schema.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_toArray">toArray</a>(
string $keyType = TableMap::TYPE_PHPNAME,
boolean $includeLazyLoadColumns = true,
array $alreadyDumpedObjects = array(),
boolean $includeForeignObjects = false)
<p>Exports the object as an array.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
void
</div>
<div class="col-md-8 type">
<a href="#method_setByName">setByName</a>(
string $name,
mixed $value,
string $type = TableMap::TYPE_PHPNAME)
<p>Sets a field from the object by name passed in as a string.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
void
</div>
<div class="col-md-8 type">
<a href="#method_setByPosition">setByPosition</a>(
int $pos,
mixed $value)
<p>Sets a field from the object by Position as specified in the xml schema.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
void
</div>
<div class="col-md-8 type">
<a href="#method_fromArray">fromArray</a>(
array $arr,
string $keyType = TableMap::TYPE_PHPNAME)
<p>Populates the object using an array.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Propel\Runtime\ActiveQuery\Criteria">Criteria</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_buildCriteria">buildCriteria</a>()
<p>Build a Criteria object containing the values of all modified columns in this object.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Propel\Runtime\ActiveQuery\Criteria">Criteria</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_buildPkeyCriteria">buildPkeyCriteria</a>()
<p>Builds a Criteria object containing the primary key for this object.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_getPrimaryKey">getPrimaryKey</a>()
<p>Returns the composite primary key for this object.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
void
</div>
<div class="col-md-8 type">
<a href="#method_setPrimaryKey">setPrimaryKey</a>(
array $keys)
<p>Set the [composite] primary key.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
boolean
</div>
<div class="col-md-8 type">
<a href="#method_isPrimaryKeyNull">isPrimaryKeyNull</a>()
<p>Returns true if the primary key for this object is null.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_copyInto">copyInto</a>(
object $copyObj,
boolean $deepCopy = false,
boolean $makeNew = true)
<p>Sets contents of passed object to values from current object.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_copy">copy</a>(
boolean $deepCopy = false)
<p>Makes a copy of this object that will be inserted as a new row in table when saved.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_setCoupon">setCoupon</a>(
<abbr title="Thelia\Model\Base\Thelia\Model\Coupon">Coupon</abbr> $v = null)
<p>Declares an association between this object and a ChildCoupon object.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../../Thelia/Model/Coupon.html"><abbr title="Thelia\Model\Coupon">Coupon</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_getCoupon">getCoupon</a>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)
<p>Get the associated ChildCoupon object</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_clear">clear</a>()
<p>Clears the current object and sets all attributes to their default values</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_clearAllReferences">clearAllReferences</a>(
boolean $deep = false)
<p>Resets all references to other model objects or collections of model objects.</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method___toString">__toString</a>()
<p>Return the string representation of this object</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
boolean
</div>
<div class="col-md-8 type">
<a href="#method_preSave">preSave</a>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)
<p>Code to be run before persisting the object</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_postSave">postSave</a>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)
<p>Code to be run after persisting the object</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
boolean
</div>
<div class="col-md-8 type">
<a href="#method_preInsert">preInsert</a>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)
<p>Code to be run before inserting to database</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_postInsert">postInsert</a>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)
<p>Code to be run after inserting to database</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
boolean
</div>
<div class="col-md-8 type">
<a href="#method_preUpdate">preUpdate</a>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)
<p>Code to be run before updating the object in database</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_postUpdate">postUpdate</a>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)
<p>Code to be run after updating the object in database</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
boolean
</div>
<div class="col-md-8 type">
<a href="#method_preDelete">preDelete</a>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)
<p>Code to be run before deleting the object in database</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_postDelete">postDelete</a>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)
<p>Code to be run after deleting the object in database</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array|string
</div>
<div class="col-md-8 type">
<a href="#method___call">__call</a>(
string $name,
mixed $params)
<p>Derived method to catches calls to undefined methods.</p> </div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method_applyDefaultValues">
<div class="location">at line 106</div>
<code>
<strong>applyDefaultValues</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Applies default values to this object.</p> <p>This method should be called from the object's constructor (or
equivalent initialization method).</p> </div>
<div class="tags">
<h4>See also</h4>
<table class="table table-condensed">
<tr>
<td>__construct()</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___construct">
<div class="location">at line 115</div>
<code>
<strong>__construct</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Initializes internal state of Thelia\Model\Base\CouponI18n object.</p> </div>
<div class="tags">
<h4>See also</h4>
<table class="table table-condensed">
<tr>
<td>applyDefaults()</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_isModified">
<div class="location">at line 125</div>
<code>
boolean
<strong>isModified</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Returns whether the object has been modified.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td>True if the object has been modified.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_isColumnModified">
<div class="location">at line 136</div>
<code>
boolean
<strong>isColumnModified</strong>(
string $col)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Has specified column been modified?</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$col</td>
<td>column fully qualified name (TableMap::TYPE<em>COLNAME), e.g. Book::AUTHOR</em>ID</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td>True if $col has been modified.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getModifiedColumns">
<div class="location">at line 145</div>
<code>
array
<strong>getModifiedColumns</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the columns that have been modified in this object.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>A unique list of the modified column names for this object.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_isNew">
<div class="location">at line 157</div>
<code>
boolean
<strong>isNew</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Returns whether the object has ever been saved. This will
be false, if the object was retrieved from storage or was created
and then saved.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td>true, if the object has never been persisted.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setNew">
<div class="location">at line 168</div>
<code>
<strong>setNew</strong>(
boolean $b)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Setter for the isNew attribute. This method will be called
by Propel-generated children and objects.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td>$b</td>
<td>the state of the object.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_isDeleted">
<div class="location">at line 177</div>
<code>
boolean
<strong>isDeleted</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Whether this object has been deleted.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td>The deleted state of this object.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setDeleted">
<div class="location">at line 187</div>
<code>
void
<strong>setDeleted</strong>(
boolean $b)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Specify whether this object has been deleted.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td>$b</td>
<td>The deleted state of this object.</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_resetModified">
<div class="location">at line 197</div>
<code>
void
<strong>resetModified</strong>(
string $col = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Sets the modified state for the object to be false.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$col</td>
<td>If supplied, only the specified column is reset.</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_equals">
<div class="location">at line 216</div>
<code>
boolean
<strong>equals</strong>(
mixed $obj)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Compares this with another <code>CouponI18n</code> instance. If
<code>obj</code> is an instance of <code>CouponI18n</code>, delegates to
<code>equals(CouponI18n)</code>. Otherwise, returns <code>false</code>.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$obj</td>
<td>The object to compare to.</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td>Whether equal to the object specified.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_hashCode">
<div class="location">at line 241</div>
<code>
int
<strong>hashCode</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>If the primary key is not null, return the hashcode of the
primary key. Otherwise, return the hash code of the object.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>Hashcode</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getVirtualColumns">
<div class="location">at line 255</div>
<code>
array
<strong>getVirtualColumns</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the associative array of the virtual columns in this object</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_hasVirtualColumn">
<div class="location">at line 266</div>
<code>
boolean
<strong>hasVirtualColumn</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Checks the existence of a virtual column in this object</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The virtual column name</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getVirtualColumn">
<div class="location">at line 279</div>
<code>
mixed
<strong>getVirtualColumn</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the value of a virtual column in this object</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The virtual column name</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td></td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><abbr title="Propel\Runtime\Exception\PropelException">PropelException</abbr></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setVirtualColumn">
<div class="location">at line 296</div>
<code>
<a href="../../../Thelia/Model/Base/CouponI18n.html"><abbr title="Thelia\Model\Base\CouponI18n">CouponI18n</abbr></a>
<strong>setVirtualColumn</strong>(
string $name,
mixed $value)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the value of a virtual column in this object</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The virtual column name</td>
</tr>
<tr>
<td>
mixed</td>
<td>$value</td>
<td>The value to give to the virtual column</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../../Thelia/Model/Base/CouponI18n.html"><abbr title="Thelia\Model\Base\CouponI18n">CouponI18n</abbr></a></td>
<td>The current object, for fluid interface</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_importFrom">
<div class="location">at line 328</div>
<code>
<a href="../../../Thelia/Model/Base/CouponI18n.html"><abbr title="Thelia\Model\Base\CouponI18n">CouponI18n</abbr></a>
<strong>importFrom</strong>(
mixed $parser,
string $data)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Populate the current object from a string, using a given parser format
<code>
$book = new Book();
$book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
</code></p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$parser</td>
<td>A AbstractParser instance,
or a format name ('XML', 'YAML', 'JSON', 'CSV')</td>
</tr>
<tr>
<td>
string</td>
<td>$data</td>
<td>The source data to import from</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../../Thelia/Model/Base/CouponI18n.html"><abbr title="Thelia\Model\Base\CouponI18n">CouponI18n</abbr></a></td>
<td>The current object, for fluid interface</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_exportTo">
<div class="location">at line 351</div>
<code>
string
<strong>exportTo</strong>(
mixed $parser,
boolean $includeLazyLoadColumns = true)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Export the current object properties to a string, using a given parser format
<code>
$book = BookQuery::create()->findPk(9012);
echo $book->exportTo('JSON');
=> {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
</code></p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$parser</td>
<td>A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV')</td>
</tr>
<tr>
<td>
boolean</td>
<td>$includeLazyLoadColumns</td>
<td>(optional) Whether to include lazy load(ed) columns. Defaults to TRUE.</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>The exported data</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___sleep">
<div class="location">at line 364</div>
<code>
<strong>__sleep</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Clean up internal collections prior to serializing
Avoids recursive loops that turn into segmentation faults when serializing</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getId">
<div class="location">at line 376</div>
<code>
int
<strong>getId</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the [id] column value.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getLocale">
<div class="location">at line 387</div>
<code>
string
<strong>getLocale</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the [locale] column value.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getTitle">
<div class="location">at line 398</div>
<code>
string
<strong>getTitle</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the [title] column value.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getShortDescription">
<div class="location">at line 409</div>
<code>
string
<strong>getShortDescription</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the [short_description] column value.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getDescription">
<div class="location">at line 420</div>
<code>
string
<strong>getDescription</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the [description] column value.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setId">
<div class="location">at line 432</div>
<code>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
<strong>setId</strong>(
int $v)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the value of [id] column.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>$v</td>
<td>new value</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a></td>
<td>The current object (for fluent API support)</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setLocale">
<div class="location">at line 457</div>
<code>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
<strong>setLocale</strong>(
string $v)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the value of [locale] column.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$v</td>
<td>new value</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a></td>
<td>The current object (for fluent API support)</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setTitle">
<div class="location">at line 478</div>
<code>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
<strong>setTitle</strong>(
string $v)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the value of [title] column.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$v</td>
<td>new value</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a></td>
<td>The current object (for fluent API support)</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setShortDescription">
<div class="location">at line 499</div>
<code>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
<strong>setShortDescription</strong>(
string $v)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the value of [short_description] column.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$v</td>
<td>new value</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a></td>
<td>The current object (for fluent API support)</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setDescription">
<div class="location">at line 520</div>
<code>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
<strong>setDescription</strong>(
string $v)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the value of [description] column.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$v</td>
<td>new value</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a></td>
<td>The current object (for fluent API support)</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_hasOnlyDefaultValues">
<div class="location">at line 543</div>
<code>
boolean
<strong>hasOnlyDefaultValues</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Indicates whether the columns in this object are only set to default values.</p> <p>This method can be used in conjunction with isModified() to indicate whether an object is both
modified <em>and</em> has some values set which are non-default.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td>Whether the columns in this object are only been set with default values.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_hydrate">
<div class="location">at line 571</div>
<code>
int
<strong>hydrate</strong>(
array $row,
int $startcol,
boolean $rehydrate = false,
string $indexType = TableMap::TYPE_NUM)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Hydrates (populates) the object variables with values from the database resultset.</p> <p>An offset (0-based "start column") is specified so that objects can be hydrated
with a subset of the columns in the resultset rows. This is needed, for example,
for results of JOIN queries where the resultset row includes columns from two or
more tables.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$row</td>
<td>The row returned by DataFetcher->fetch().</td>
</tr>
<tr>
<td>
int</td>
<td>$startcol</td>
<td>0-based offset column which indicates which restultset column to start with.</td>
</tr>
<tr>
<td>
boolean</td>
<td>$rehydrate</td>
<td>Whether this object is being re-hydrated from the database.</td>
</tr>
<tr>
<td>
string</td>
<td>$indexType</td>
<td>The index type of $row. Mostly DataFetcher->getIndexType().
One of the class type constants TableMap::TYPE<em>PHPNAME, TableMap::TYPE</em>STUDLYPHPNAME
TableMap::TYPE<em>COLNAME, TableMap::TYPE</em>FIELDNAME, TableMap::TYPE_NUM.</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>next starting column</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><abbr title="Propel\Runtime\Exception\PropelException">PropelException</abbr></td>
<td><ul>
<li>Any caught Exception will be rewrapped as a PropelException.</li>
</ul>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_ensureConsistency">
<div class="location">at line 618</div>
<code>
<strong>ensureConsistency</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Checks and repairs the internal consistency of the object.</p> <p>This method is executed after an already-instantiated object is re-hydrated
from the database. It exists to check any foreign keys to make sure that
the objects related to the current object are correct based on foreign key.</p>
<p>You can override this method in the stub class, but you should always invoke
the base method from the overridden method (i.e. parent::ensureConsistency()),
in case your model changes.</p> </div>
<div class="tags">
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><abbr title="Propel\Runtime\Exception\PropelException">PropelException</abbr></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_reload">
<div class="location">at line 635</div>
<code>
void
<strong>reload</strong>(
boolean $deep = false,
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Reloads this object from datastore based on primary key and (optionally) resets all associated objects.</p> <p>This will only work if the object has been saved and has a valid primary key set.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td>$deep</td>
<td>(optional) Whether to also de-associated any related objects.</td>
</tr>
<tr>
<td>
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr></td>
<td>$con</td>
<td>(optional) The ConnectionInterface connection to use.</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td></td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><abbr title="Propel\Runtime\Exception\PropelException">PropelException</abbr></td>
<td><ul>
<li>if this object is deleted, unsaved or doesn't have pk match in db</li>
</ul>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_delete">
<div class="location">at line 675</div>
<code>
void
<strong>delete</strong>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Removes this object from datastore and sets delete attribute.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr></td>
<td>$con</td>
<td></td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td></td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><abbr title="Propel\Runtime\Exception\PropelException">PropelException</abbr></td>
<td></td>
</tr>
</table>
<h4>See also</h4>
<table class="table table-condensed">
<tr>
<td>CouponI18n::setDeleted()</td>
<td></td>
</tr>
<tr>
<td>CouponI18n::isDeleted()</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_save">
<div class="location">at line 717</div>
<code>
int
<strong>save</strong>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Persists this object to the database.</p> <p>If the object is new, it inserts it; otherwise an update is performed.
All modified related objects will also be persisted in the doSave()
method. This method wraps all precipitate database operations in a
single transaction.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr></td>
<td>$con</td>
<td></td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>The number of rows affected by this insert/update and any referring fk objects' save() operations.</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><abbr title="Propel\Runtime\Exception\PropelException">PropelException</abbr></td>
<td></td>
</tr>
</table>
<h4>See also</h4>
<table class="table table-condensed">
<tr>
<td>doSave()</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getByName">
<div class="location">at line 897</div>
<code>
mixed
<strong>getByName</strong>(
string $name,
string $type = TableMap::TYPE_PHPNAME)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Retrieves a field from the object by name passed in as a string.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>name</td>
</tr>
<tr>
<td>
string</td>
<td>$type</td>
<td>The type of fieldname the $name is of:
one of the class type constants TableMap::TYPE<em>PHPNAME, TableMap::TYPE</em>STUDLYPHPNAME
TableMap::TYPE<em>COLNAME, TableMap::TYPE</em>FIELDNAME, TableMap::TYPE<em>NUM.
Defaults to TableMap::TYPE</em>PHPNAME.</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>Value of field.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getByPosition">
<div class="location">at line 912</div>
<code>
mixed
<strong>getByPosition</strong>(
int $pos)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Retrieves a field from the object by Position as specified in the xml schema.</p> <p>Zero-based.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>$pos</td>
<td>position in xml schema</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>Value of field at $pos</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_toArray">
<div class="location">at line 951</div>
<code>
array
<strong>toArray</strong>(
string $keyType = TableMap::TYPE_PHPNAME,
boolean $includeLazyLoadColumns = true,
array $alreadyDumpedObjects = array(),
boolean $includeForeignObjects = false)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Exports the object as an array.</p> <p>You can specify the key type of the array by passing one of the class
type constants.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$keyType</td>
<td>(optional) One of the class type constants TableMap::TYPE<em>PHPNAME, TableMap::TYPE</em>STUDLYPHPNAME,
TableMap::TYPE<em>COLNAME, TableMap::TYPE</em>FIELDNAME, TableMap::TYPE<em>NUM.
Defaults to TableMap::TYPE</em>PHPNAME.</td>
</tr>
<tr>
<td>
boolean</td>
<td>$includeLazyLoadColumns</td>
<td>(optional) Whether to include lazy loaded columns. Defaults to TRUE.</td>
</tr>
<tr>
<td>
array</td>
<td>$alreadyDumpedObjects</td>
<td>List of objects to skip to avoid recursion</td>
</tr>
<tr>
<td>
boolean</td>
<td>$includeForeignObjects</td>
<td>(optional) Whether to include hydrated related objects. Default to FALSE.</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>an associative array containing the field names (as keys) and field values</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setByName">
<div class="location">at line 990</div>
<code>
void
<strong>setByName</strong>(
string $name,
mixed $value,
string $type = TableMap::TYPE_PHPNAME)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Sets a field from the object by name passed in as a string.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td></td>
</tr>
<tr>
<td>
mixed</td>
<td>$value</td>
<td>field value</td>
</tr>
<tr>
<td>
string</td>
<td>$type</td>
<td>The type of fieldname the $name is of:
one of the class type constants TableMap::TYPE<em>PHPNAME, TableMap::TYPE</em>STUDLYPHPNAME
TableMap::TYPE<em>COLNAME, TableMap::TYPE</em>FIELDNAME, TableMap::TYPE<em>NUM.
Defaults to TableMap::TYPE</em>PHPNAME.</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setByPosition">
<div class="location">at line 1005</div>
<code>
void
<strong>setByPosition</strong>(
int $pos,
mixed $value)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Sets a field from the object by Position as specified in the xml schema.</p> <p>Zero-based.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>$pos</td>
<td>position in xml schema</td>
</tr>
<tr>
<td>
mixed</td>
<td>$value</td>
<td>field value</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_fromArray">
<div class="location">at line 1043</div>
<code>
void
<strong>fromArray</strong>(
array $arr,
string $keyType = TableMap::TYPE_PHPNAME)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Populates the object using an array.</p> <p>This is particularly useful when populating an object from one of the
request arrays (e.g. $_POST). This method goes through the column
names, checking to see whether a matching key exists in populated
array. If so the setByName() method is called for that column.</p>
<p>You can specify the key type of the array by additionally passing one
of the class type constants TableMap::TYPE<em>PHPNAME, TableMap::TYPE</em>STUDLYPHPNAME,
TableMap::TYPE<em>COLNAME, TableMap::TYPE</em>FIELDNAME, TableMap::TYPE<em>NUM.
The default key type is the column's TableMap::TYPE</em>PHPNAME.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$arr</td>
<td>An array to populate the object from.</td>
</tr>
<tr>
<td>
string</td>
<td>$keyType</td>
<td>The type of keys the array uses.</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_buildCriteria">
<div class="location">at line 1059</div>
<code>
<abbr title="Propel\Runtime\ActiveQuery\Criteria">Criteria</abbr>
<strong>buildCriteria</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Build a Criteria object containing the values of all modified columns in this object.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Propel\Runtime\ActiveQuery\Criteria">Criteria</abbr></td>
<td>The Criteria object containing all modified values.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_buildPkeyCriteria">
<div class="location">at line 1080</div>
<code>
<abbr title="Propel\Runtime\ActiveQuery\Criteria">Criteria</abbr>
<strong>buildPkeyCriteria</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Builds a Criteria object containing the primary key for this object.</p> <p>Unlike buildCriteria() this method includes the primary key values regardless
of whether or not they have been modified.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Propel\Runtime\ActiveQuery\Criteria">Criteria</abbr></td>
<td>The Criteria object containing value(s) for primary key(s).</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getPrimaryKey">
<div class="location">at line 1094</div>
<code>
array
<strong>getPrimaryKey</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Returns the composite primary key for this object.</p> <p>The array elements will be in same order as specified in XML.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setPrimaryKey">
<div class="location">at line 1109</div>
<code>
void
<strong>setPrimaryKey</strong>(
array $keys)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Set the [composite] primary key.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$keys</td>
<td>The elements of the composite key (order must match the order in XML file).</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_isPrimaryKeyNull">
<div class="location">at line 1119</div>
<code>
boolean
<strong>isPrimaryKeyNull</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Returns true if the primary key for this object is null.</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_copyInto">
<div class="location">at line 1136</div>
<code>
<strong>copyInto</strong>(
object $copyObj,
boolean $deepCopy = false,
boolean $makeNew = true)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Sets contents of passed object to values from current object.</p> <p>If desired, this method can also make copies of all associated (fkey referrers)
objects.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
object</td>
<td>$copyObj</td>
<td>An object of \Thelia\Model\CouponI18n (or compatible) type.</td>
</tr>
<tr>
<td>
boolean</td>
<td>$deepCopy</td>
<td>Whether to also copy all rows that refer (by fkey) to the current row.</td>
</tr>
<tr>
<td>
boolean</td>
<td>$makeNew</td>
<td>Whether to reset autoincrement PKs and make the object new.</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><abbr title="Propel\Runtime\Exception\PropelException">PropelException</abbr></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_copy">
<div class="location">at line 1160</div>
<code>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
<strong>copy</strong>(
boolean $deepCopy = false)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Makes a copy of this object that will be inserted as a new row in table when saved.</p> <p>It creates a new object filling in the simple attributes, but skipping any primary
keys that are defined for the table.</p>
<p>If desired, this method can also make copies of all associated (fkey referrers)
objects.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td>$deepCopy</td>
<td>Whether to also copy all rows that refer (by fkey) to the current row.</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a></td>
<td>Clone of current object.</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><abbr title="Propel\Runtime\Exception\PropelException">PropelException</abbr></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setCoupon">
<div class="location">at line 1177</div>
<code>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a>
<strong>setCoupon</strong>(
<abbr title="Thelia\Model\Base\Thelia\Model\Coupon">Coupon</abbr> $v = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Declares an association between this object and a ChildCoupon object.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Thelia\Model\Base\Thelia\Model\Coupon">Coupon</abbr></td>
<td>$v</td>
<td></td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../../Thelia/Model/CouponI18n.html"><abbr title="Thelia\Model\CouponI18n">CouponI18n</abbr></a></td>
<td>The current object (for fluent API support)</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><abbr title="Propel\Runtime\Exception\PropelException">PropelException</abbr></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getCoupon">
<div class="location">at line 1205</div>
<code>
<a href="../../../Thelia/Model/Coupon.html"><abbr title="Thelia\Model\Coupon">Coupon</abbr></a>
<strong>getCoupon</strong>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the associated ChildCoupon object</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr></td>
<td>$con</td>
<td>Optional Connection object.</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../../../Thelia/Model/Coupon.html"><abbr title="Thelia\Model\Coupon">Coupon</abbr></a></td>
<td>The associated ChildCoupon object.</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><abbr title="Propel\Runtime\Exception\PropelException">PropelException</abbr></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_clear">
<div class="location">at line 1224</div>
<code>
<strong>clear</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Clears the current object and sets all attributes to their default values</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_clearAllReferences">
<div class="location">at line 1248</div>
<code>
<strong>clearAllReferences</strong>(
boolean $deep = false)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Resets all references to other model objects or collections of model objects.</p> <p>This method is a user-space workaround for PHP's inability to garbage collect
objects with circular references (even in PHP 5.3). This is currently necessary
when using Propel in certain daemon or large-volume/high-memory operations.</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td>$deep</td>
<td>Whether to also clear the references on all referrer objects.</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___toString">
<div class="location">at line 1261</div>
<code>
string
<strong>__toString</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Return the string representation of this object</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_preSave">
<div class="location">at line 1271</div>
<code>
boolean
<strong>preSave</strong>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Code to be run before persisting the object</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr></td>
<td>$con</td>
<td></td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_postSave">
<div class="location">at line 1280</div>
<code>
<strong>postSave</strong>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Code to be run after persisting the object</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr></td>
<td>$con</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_preInsert">
<div class="location">at line 1290</div>
<code>
boolean
<strong>preInsert</strong>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Code to be run before inserting to database</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr></td>
<td>$con</td>
<td></td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_postInsert">
<div class="location">at line 1299</div>
<code>
<strong>postInsert</strong>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Code to be run after inserting to database</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr></td>
<td>$con</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_preUpdate">
<div class="location">at line 1309</div>
<code>
boolean
<strong>preUpdate</strong>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Code to be run before updating the object in database</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr></td>
<td>$con</td>
<td></td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_postUpdate">
<div class="location">at line 1318</div>
<code>
<strong>postUpdate</strong>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Code to be run after updating the object in database</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr></td>
<td>$con</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_preDelete">
<div class="location">at line 1328</div>
<code>
boolean
<strong>preDelete</strong>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Code to be run before deleting the object in database</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr></td>
<td>$con</td>
<td></td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
boolean</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_postDelete">
<div class="location">at line 1337</div>
<code>
<strong>postDelete</strong>(
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr> $con = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Code to be run after deleting the object in database</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="Thelia\Model\Base\Propel\Runtime\Connection\ConnectionInterface">ConnectionInterface</abbr></td>
<td>$con</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___call">
<div class="location">at line 1354</div>
<code>
array|string
<strong>__call</strong>(
string $name,
mixed $params)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Derived method to catches calls to undefined methods.</p> <p>Provides magic import/export method support (fromXML()/toXML(), fromYAML()/toYAML(), etc.).
Allows to define default __call() behavior if you overwrite __call()</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td></td>
</tr>
<tr>
<td>
mixed</td>
<td>$params</td>
<td></td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array|string</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
</div>
</div>
</div>
</body>
</html>
|
sitecrafting/thelia.github.io
|
api/master/Thelia/Model/Base/CouponI18n.html
|
HTML
|
mit
| 113,689 |
<!DOCTYPE html>
<!--
Template Name: Metronic - Responsive Admin Dashboard Template build with Twitter Bootstrap 3.3.2
Version: 3.6.2
Author: KeenThemes
Website: http://www.keenthemes.com/
Contact: [email protected]
Follow: www.twitter.com/keenthemes
Like: www.facebook.com/keenthemes
Purchase: http://themeforest.net/item/metronic-responsive-admin-dashboard-template/4021469?ref=keenthemes
License: You must have a valid license purchased only from themeforest(the above link) in order to legally use the theme for your project.
-->
<!--[if IE 8]> <html lang="en" class="ie8 no-js"> <![endif]-->
<!--[if IE 9]> <html lang="en" class="ie9 no-js"> <![endif]-->
<!--[if !IE]><!-->
<html lang="en">
<!--<![endif]-->
<!-- BEGIN HEAD -->
<head>
<meta charset="utf-8"/>
<title>Metronic | Lock Screen 2</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
<meta http-equiv="Content-type" content="text/html; charset=utf-8">
<meta content="" name="description"/>
<meta content="" name="author"/>
<!-- BEGIN GLOBAL MANDATORY STYLES -->
<link href="http://fonts.googleapis.com/css?family=Open+Sans:400,300,600,700&subset=all" rel="stylesheet" type="text/css"/>
<link href="../../assets/global/plugins/font-awesome/css/font-awesome.min.css" rel="stylesheet" type="text/css"/>
<link href="../../assets/global/plugins/simple-line-icons/simple-line-icons.min.css" rel="stylesheet" type="text/css"/>
<link href="../../assets/global/plugins/bootstrap/css/bootstrap.min.css" rel="stylesheet" type="text/css"/>
<link href="../../assets/global/plugins/uniform/css/uniform.default.css" rel="stylesheet" type="text/css"/>
<!-- END GLOBAL MANDATORY STYLES -->
<!-- BEGIN PAGE LEVEL STYLES -->
<link href="../../assets/admin/pages/css/lock2.css" rel="stylesheet" type="text/css"/>
<!-- END PAGE LEVEL STYLES -->
<!-- BEGIN THEME STYLES -->
<link href="../../assets/global/css/components-rounded.css" id="style_components" rel="stylesheet" type="text/css"/>
<link href="../../assets/global/css/plugins.css" rel="stylesheet" type="text/css"/>
<link href="../../assets/admin/layout/css/layout.css" rel="stylesheet" type="text/css"/>
<link href="../../assets/admin/layout/css/themes/default.css" rel="stylesheet" type="text/css" id="style_color"/>
<link href="../../assets/admin/layout/css/custom.css" rel="stylesheet" type="text/css"/>
<!-- END THEME STYLES -->
<link rel="shortcut icon" href="favicon.ico"/>
</head>
<!-- END HEAD -->
<!-- BEGIN BODY -->
<body>
<div class="page-lock">
<div class="page-logo">
<a class="brand" href="index.html">
<img src="../../assets/admin/layout3/img/logo-big.png" alt="logo"/>
</a>
</div>
<div class="page-body">
<img class="page-lock-img" src="../../assets/admin/pages/media/profile/profile.jpg" alt="">
<div class="page-lock-info">
<h1>Bob Nilson</h1>
<span class="email">
[email protected] </span>
<span class="locked">
Locked </span>
<form class="form-inline" action="index.html">
<div class="input-group input-medium">
<input type="text" class="form-control" placeholder="Password">
<span class="input-group-btn">
<button type="submit" class="btn blue icn-only"><i class="m-icon-swapright m-icon-white"></i></button>
</span>
</div>
<!-- /input-group -->
<div class="relogin">
<a href="login.html">
Not Bob Nilson ? </a>
</div>
</form>
</div>
</div>
<div class="page-footer-custom">
2014 © Metronic. Admin Dashboard Template.
</div>
</div>
<!-- BEGIN JAVASCRIPTS(Load javascripts at bottom, this will reduce page load time) -->
<!-- BEGIN CORE PLUGINS -->
<!--[if lt IE 9]>
<script src="../../assets/global/plugins/respond.min.js"></script>
<script src="../../assets/global/plugins/excanvas.min.js"></script>
<![endif]-->
<script src="../../assets/global/plugins/jquery.min.js" type="text/javascript"></script>
<script src="../../assets/global/plugins/jquery-migrate.min.js" type="text/javascript"></script>
<script src="../../assets/global/plugins/bootstrap/js/bootstrap.min.js" type="text/javascript"></script>
<script src="../../assets/global/plugins/jquery.blockui.min.js" type="text/javascript"></script>
<script src="../../assets/global/plugins/uniform/jquery.uniform.min.js" type="text/javascript"></script>
<script src="../../assets/global/plugins/jquery.cokie.min.js" type="text/javascript"></script>
<!-- END CORE PLUGINS -->
<!-- BEGIN PAGE LEVEL PLUGINS -->
<script src="../../assets/global/plugins/backstretch/jquery.backstretch.min.js" type="text/javascript"></script>
<!-- END PAGE LEVEL PLUGINS -->
<script src="../../assets/global/scripts/metronic.js" type="text/javascript"></script>
<script src="../../assets/admin/layout/scripts/layout.js" type="text/javascript"></script>
<script src="../../assets/admin/layout/scripts/demo.js" type="text/javascript"></script>
<script src="../../assets/admin/pages/scripts/lock.js"></script>
<script>
jQuery(document).ready(function() {
Metronic.init(); // init metronic core components
Layout.init(); // init current layout
Lock.init();
Demo.init();
});
</script>
<!-- END JAVASCRIPTS -->
</body>
<!-- END BODY -->
</html>
|
nusratjahanjinia/test
|
public/metronic/ftfl02/templates/admin3/extra_lock2.html
|
HTML
|
mit
| 5,195 |
{% extends 'cats/base.html' %}
{% load i18n %}
{% block title %}{% trans "Kittens" %}{% endblock %}
{% block page_header %}
{% include "horizon/common/_page_header.html" with title=_("Kittens") %}
{% endblock page_header %}
{% block cats_main %}
{% endblock %}
|
tylertian/Openstack
|
openstack F/horizon/horizon/tests/test_dashboards/cats/kittens/templates/kittens/index.html
|
HTML
|
apache-2.0
| 267 |
<!DOCTYPE html>
<html>
<head>
<script src="../../../resources/js-test.js"></script>
<script src="../resources/multiple-fields-ax-aria-attributes.js"></script>
</head>
<body>
<input id="test" type="date">
<script>
description('This test checks aria-help attribute of fields in multiple fields date input UI.');
var testInput = document.getElementById('test');
if (!window.accessibilityController || !window.eventSender)
debug('Please run inside DRT or WTR.');
else {
testInput.focus();
debug('Initial empty state');
checkFocusedElementAXAttributes('Month, AXValueDescription: blank, intValue:0, range:1-12');
eventSender.keyDown('\t');
checkFocusedElementAXAttributes('Day, AXValueDescription: blank, intValue:0, range:1-31');
eventSender.keyDown('\t');
checkFocusedElementAXAttributes('Year, AXValueDescription: blank, intValue:0, range:1-275760');
eventSender.keyDown('\t', ['shiftKey']);
eventSender.keyDown('\t', ['shiftKey']);
debug('Non-empty value');
testInput.value = "2012-10-09";
checkFocusedElementAXAttributes('Month, AXValueDescription: 10, intValue:10, range:1-12');
eventSender.keyDown('\t');
checkFocusedElementAXAttributes('Day, AXValueDescription: 09, intValue:9, range:1-31');
eventSender.keyDown('\t');
checkFocusedElementAXAttributes('Year, AXValueDescription: 2012, intValue:2012, range:1-275760');
debug('Empty value');
eventSender.keyDown('\b');
checkFocusedElementAXAttributes('Year, AXValueDescription: blank, intValue:0, range:1-275760');
eventSender.keyDown('\t', ['shiftKey']);
eventSender.keyDown('\b');
checkFocusedElementAXAttributes('Day, AXValueDescription: blank, intValue:0, range:1-31');
eventSender.keyDown('\t', ['shiftKey']);
eventSender.keyDown('\b');
checkFocusedElementAXAttributes('Month, AXValueDescription: blank, intValue:0, range:1-12');
debug('');
testInput.parentNode.removeChild(testInput);
}
</script>
</body>
</html>
|
js0701/chromium-crosswalk
|
third_party/WebKit/LayoutTests/fast/forms/date-multiple-fields/date-multiple-fields-ax-aria-attributes.html
|
HTML
|
bsd-3-clause
| 1,986 |
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Introduction to Atom</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<style type="text/css" media="screen">
@import "../css/common.css";
@import "../css/documentation.css";
#main h2 { font-size: 200%; }
pre { padding-left: 3em; }
</style>
<script type="text/javascript"><!-- --></script>
</head>
<body>
<div id="logo">
<h1><a href="/"><span id="feed"><span id="f">F</span><span id="e1">E</span><span id="e2">E</span></span><span id="d">D</span> Validator</a></h1>
<p>Introduction to Atom</p>
<a class="skip" href="#startnavigation">Jump to navigation</a>
</div> <!--logo-->
<div id="main">
<h2>Contents</h2>
<ul>
<li><a href="#whatIsAtom">What is Atom?</a>
<ul>
<li><a href="#aboutThisDocument">About this document</a></li>
<li><a href="#sampleFeed">Sample feed</a></li>
</ul>
</li>
<li>Feed Elements
<ul>
<li><a href="#requiredFeedElements">Required</a></li>
<li><a href="#recommendedFeedElements">Recommended</a></li>
<li><a href="#optionalFeedElements">Optional</a></li>
</ul>
</li>
<li>Entry Elements
<ul>
<li><a href="#requiredEntryElements">Required</a></li>
<li><a href="#recommendedEntryElements">Recommended</a></li>
<li><a href="#optionalEntryElements">Optional</a></li>
</ul>
</li>
<li>Common Constructs
<ul>
<li><a href="#category">Category</a></li>
<li><a href="#contentElement">Content</a></li>
<li><a href="#link">Link</a></li>
<li><a href="#person">Person</a></li>
<li><a href="#text">Text</a></li>
</ul>
</li>
<li><a href="#extensibility">Extending Atom</a></li>
<li><a href="#seeAlso">See Also</a></li>
</ul>
<h2>What is Atom?<a id="whatIsAtom" name="whatIsAtom"></a></h2>
<p>Atom is the name of an XML-based Web content and metadata syndication format, and an application-level protocol for publishing and editing Web resources belonging to periodically updated websites.</p>
<p>All Atom feeds must be well-formed <a href="http://www.w3.org/TR/REC-xml">XML</a> documents, and are identified with the <code>application/atom+xml</code> media type.</p>
<h3>About this document<a id="aboutThisDocument" name="aboutThisDocument"> </a></h3>
<p>This document focuses on
<a href="rfc4287.html">The Atom Syndication Format</a>
produced by the
<a href="http://www.ietf.org/" title="Internet Engineering Task Force">IETF</a>
<a href="http://www.ietf.org/html.charters/atompub-charter.html">AtomPub Working Group</a>. In the event that this document differs from the Internet Draft, the Internet Draft is to be considered authoritative.</p>
<p>General considerations:</p>
<ul>
<li>All elements described in this document must be in the <a href="http://www.w3.org/2005/Atom">http://www.w3.org/2005/Atom</a> namespace.</li>
<li>All timestamps in Atom must conform to <a href="http://www.faqs.org/rfcs/rfc3339.html">RFC 3339</a>.</li>
<li>Unless otherwise specified, all values must be plain text (i.e., no entity-encoded html).</li>
<li><a href="http://www.w3.org/TR/REC-xml/#sec-lang-tag"><code>xml:lang</code></a> may be used to identify the language of any human readable text.</li>
<li><a href="http://www.w3.org/TR/xmlbase/"><code>xml:base</code></a> may be used to control how relative <abbr title="Universal Resource Identifier">URI</abbr>s are resolved.</li>
</ul>
<h3>Sample feed<a id="sampleFeed" name="sampleFeed"> </a></h3>
<pre>
<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
<title>Example Feed</title>
<link href="http://example.org/"/>
<updated>2003-12-13T18:30:02Z</updated>
<author>
<name>John Doe</name>
</author>
<id>urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6</id>
<entry>
<title>Atom-Powered Robots Run Amok</title>
<link href="http://example.org/2003/12/13/atom03"/>
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
<updated>2003-12-13T18:30:02Z</updated>
<summary>Some text.</summary>
</entry>
</feed>
</pre>
<h2>Elements of <feed></h2>
A Feed consists of some metadata, followed by any number of entries.
<h3>Required feed elements<a id="requiredFeedElements" name="requiredFeedElements"> </a></h3>
<p>Here's a list of the required feed elements, each with a brief description, and an example.</p>
<table cellspacing="10">
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td valign="top">id</td>
<td valign="top">Identifies the feed using a universally unique and permanent
<abbr title="Universal Resource Identifier">URI</abbr>.
If you have a long-term, renewable lease on your Internet domain name,
then you can feel free to use your website's address.
<pre><id>http://example.com/</id></pre></td>
</tr>
<tr>
<td valign="top">title</td>
<td valign="top">Contains a human readable title for the feed. Often the same
as the title of the associated website. This value should not be blank.
<pre><title>Example, Inc.</title></pre></td>
</tr>
<tr>
<td valign="top">updated</td>
<td valign="top">Indicates the last time the feed was modified in a
significant way.
<pre><updated>2003-12-13T18:30:02Z</updated></pre></td>
</tr>
</table>
<h3>Recommended feed elements<a id="recommendedFeedElements" name="recommendedFeedElements"> </a></h3>
Atom makes a number of additional requirements and recommendations for feed elements that you should to be aware of. They are as follows:
<table cellspacing="10">
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td valign="top">author</td>
<td valign="top">Names one author of the feed. A feed may have multiple
<code>author</code> elements. A feed must contain at least one
<code>author</code> element unless <b>all</b> of the <code>entry</code>
elements contain at least one <code>author</code> element. More
info <a href="#person">here</a>.
<pre><author>
<name>John Doe</name>
<email>[email protected]</email>
<uri>http://example.com/~johndoe</uri>
</author></pre></td>
</tr>
<tr>
<td valign="top">link</td>
<td valign="top">Identifies a related Web page. The type of relation is defined by the <code>rel</code> attribute. A feed is limited to one <code>alternate</code> per <code>type</code> and <code>hreflang</code>. A feed should contain a link back to the feed itself. More info <a href="#link">here</a>.
<pre><link rel="self" href="/feed" /></pre></td>
</tr>
</table>
<h3>Optional feed elements<a id="optionalFeedElements" name="optionalFeedElements"> </a></h3>
<p>Here's a list of optional feed elements.</p>
<table cellspacing="10">
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td valign="top">category</td>
<td valign="top">Specifies a category that the feed belongs to. A <code>feed</code> may have multiple <code>category</code> elements. More info <a href="#category">here</a>.
<pre><category term="sports"/></pre></td>
</tr>
<tr>
<td valign="top">contributor</td>
<td valign="top">Names one contributor to the feed. An feed may have multiple contributor elements. More info <a href="#person">here</a>.
<pre><contributor>
<name>Jane Doe</name>
</contributor></pre></td>
</tr>
<tr>
<td valign="top">generator</td>
<td valign="top">Identifies the software used to generate the feed, for debugging and other purposes. Both the <abbr title="Uniform Resource Identifier">uri</abbr> and <code>version</code> attributes are optional.
<pre><generator uri="/myblog.php" version="1.0">
Example Toolkit
</generator></pre></td>
</tr>
<tr>
<td valign="top">icon</td>
<td valign="top">Identifies a small image which provides iconic visual identification for the feed. Icons should be square.
<pre><icon>/icon.jpg</icon></pre></td>
</tr>
<tr>
<td valign="top">logo</td>
<td valign="top">Identifies a larger image which provides visual identification for the feed. Images should be twice as wide as they are tall.
<pre><logo>/logo.jpg</logo></pre></td>
</tr>
<tr>
<td valign="top">rights</td>
<td valign="top">Conveys information about rights, e.g. copyrights, held in and over the feed. More info <a href="#text">here</a>.
<pre><rights> © 2005 John Doe </rights></pre></td>
</tr>
<tr>
<td valign="top">subtitle</td>
<td valign="top">Contains a human-readable description or subtitle for the feed. More info <a href="#text">here</a>.
<pre><subtitle>all your examples are belong to us</subtitle></pre></td>
</tr>
</table>
<h2>Elements of <entry></h2>
An example of an entry would be a single post on a weblog.
<h3>Required Elements of <entry><a id="requiredEntryElements" name="requiredEntryElements"> </a></h3>
<p>Here's a list of the required feed elements, each with a brief description, and an example.</p>
<table cellspacing="10">
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td valign="top">id</td>
<td valign="top">Identifies the entry using a universally unique and permanent
<abbr title="Universal Resource Identifier">URI</abbr>.
Suggestions on how to make a good id can be found
<a href="http://diveintomark.org/archives/2004/05/28/howto-atom-id">here</a>.
Two entries in a feed can have the same value for id if they represent the
same entry at different points in time.
<pre><id>http://example.com/blog/1234</id></pre></td>
</tr>
<tr>
<td valign="top">title</td>
<td valign="top">Contains a human readable title for the entry.
This value should not be blank.
<pre><title>Atom-Powered Robots Run Amok</title></pre></td>
</tr>
<tr>
<td valign="top">updated</td>
<td valign="top">Indicates the last time the entry was modified in a
significant way. This value need not change after a typo is fixed, only
after a substantial modification. Generally, different entries in a feed
will have different updated timestamps.
<pre><updated>2003-12-13T18:30:02-05:00</updated></pre></td>
</tr>
</table>
<h3>Recommended elements of <entry><a id="recommendedEntryElements" name="recommendedEntryElements"> </a></h3>
Atom makes a number of additional requirements and recommendations for entry elements that you should to be aware of. They are as follows:
<table cellspacing="10">
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td valign="top">author</td>
<td valign="top">Names one author of the entry. An entry
may have multiple authors. An entry must contain at least one
<code>author</code> element unless there is an <code>author</code> element
in the enclosing <code>feed</code>, or there is an <code>author</code> element
in the enclosed <code>source</code> element.
More info <a href="#person">here</a>.
<pre><author>
<name>John Doe</name>
</author></pre></td>
</tr>
<tr>
<td valign="top">content</td>
<td valign="top">Contains or links to the complete content of the entry. Content must be provided if there is no <code>alternate</code> link, and should be provided if there is no <code>summary</code>. More info <a href="#content">here</a>.
<pre><content>complete story here</content></pre></td>
</tr>
<tr>
<td valign="top">link</td>
<td valign="top">Identifies a related Web page. The type of relation is defined by the <code>rel</code> attribute. An entry is limited to one <code>alternate</code> per <code>type</code> and <code>hreflang</code>. An entry must contain an <code>alternate</code> link if there is no <code>content</code> element. More info <a href="#link">here</a>.
<pre><link rel="alternate" href="/blog/1234"/></pre></td>
</tr>
<tr>
<td valign="top">summary</td>
<td valign="top">Conveys a short summary, abstract, or excerpt of the entry. Summary should be provided if there either is no content provided for the entry, or that content is not inline (i.e., contains a src attribute), or if the content is encoded in base64. More info <a href="#text">here</a>.
<pre><summary>Some text.</summary></pre></td>
</tr>
</table>
<h3>Optional elements of <entry><a id="optionalEntryElements" name="optionalEntryElements"> </a></h3>
<p>Here's a list of optional feed elements.</p>
<table cellspacing="10">
<tr>
<th>Element</th>
<th>Description</th>
</tr>
<tr>
<td valign="top">category</td>
<td valign="top">Specifies a category that the entry belongs to. A <code>entry</code> may have multiple <code>category</code> elements. More info <a href="#category">here</a>.
<pre><category term="technology"/></pre></td>
</tr>
<tr>
<td valign="top">contributor</td>
<td valign="top">Names one contributor to the entry. An entry may have multiple <code>contributor</code> elements. More info <a href="#person">here</a>.
<pre><contributor>
<name>Jane Doe</name>
</contributor></pre></td>
</tr>
<tr>
<td valign="top">published</td>
<td valign="top">Contains the time of the initial creation or first availability of the entry.
<pre><published>2003-12-13T09:17:51-08:00</published></pre></td>
</tr>
<tr>
<td valign="top">rights</td>
<td valign="top">Conveys information about rights, e.g. copyrights, held in and over the entry. More info <a href="#text">here</a>.
<pre><rights type="html">
&amp;copy; 2005 John Doe
</rights></pre></td>
</tr>
<tr>
<td valign="top">source</td>
<td valign="top">Contains metadata from the source feed if this
entry is a copy.
<pre><source>
<id>http://example.org/</id>
<title>Example, Inc.</title>
<updated>2003-12-13T18:30:02Z</updated>
</source></pre></td>
</tr>
</table>
<h2>Common Constructs</h2>
<h3 id="category">Category<a name="category"> </a></h3>
<p><code><category></code> has one required attribute, <code>term</code>, and two optional attributes, <code>scheme</code> and <code>label</code>.</p>
<p><code>term</code> identifies the category</p>
<p><code>scheme</code> identifies the categorization scheme via a
<abbr title="Universal Resource Identifier">URI</abbr>.
</p>
<p><code>label</code> provides a human-readable label for display</p>
<h3>Content<a id="contentElement" name="contentElement"> </a></h3>
<p><code><content></code> either contains, or links to, the complete content of the entry.</p>
<p>In the most common case, the <code>type</code> attribute is either <code>text</code>, <code>html</code>, <code>xhtml</code>, in which case the content element is defined identically to other text constructs, which are described <a href="#text">here</a>.</p>
<p>Otherwise, if the <code>src</code> attribute is present, it represents the <abbr title="Universal Resource Identifier">URI</abbr> of where the content can be found. The <code>type</code> attribute, if present, is the media type of the content.</p>
<p>Otherwise, if the <code>type</code> attribute ends in <code>+xml</code> or <code>/xml</code>, then an xml document of this type is contained inline.</p>
<p>Otherwise, if the <code>type</code> attribute starts with <code>text</code>, then an escaped document of this type is contained inline.</p>
<p>Otherwise, a <a href="http://www.faqs.org/rfcs/rfc3548.html">base64</a> encoded document of the indicated media type is contained inline.</p>
<h3 id="link">Link<a name="link"> </a></h3>
<p><code><link></code> is patterned after html's <a href="http://www.w3.org/TR/1999/REC-html401-19991224/struct/links.html#h-12.3">link</a> element. It has one required attribute, <code>href</code>, and five optional attributes: <code>rel</code>, <code>type</code>, <code>hreflang</code>, <code>title</code>, and <code>length</code>.</p>
<p><code>href</code> is the <abbr title="Universal Resource Identifier">URI</abbr> of the referenced resource (typically a Web page)</p>
<p><code>rel</code> contains a single link relationship type. It can be a full <abbr title="Universal Resource Identifier">URI</abbr> (see <a href="#extensibility">extensibility</a>), or one of the following predefined values (default=<code>alternate)</code>:</p>
<ul>
<li><code>alternate</code>: an alternate representation of the entry or feed, for example a permalink to the html version of the entry, or the front page of the weblog.</li>
<li><code>enclosure</code>: a related resource which is potentially large in size and might require special handling, for example an audio or video recording.</li>
<li><code>related</code>: an document related to the entry or feed.</li>
<li><code>self</code>: the feed itself.</li>
<li><code>via</code>: the source of the information provided in the entry.</li>
</ul>
<p><code>type</code> indicates the media type of the resource.</p>
<p><code>hreflang</code> indicates the language of the referenced resource.</p>
<p><code>title</code> human readable information about the link, typically for display purposes.</p>
<p><code>length</code> the length of the resource, in bytes.</p>
<h3 id="person">Person<a name="person"> </a></h3>
<p><code><author></code> and <code><contributor></code> describe a person, corporation, or similar entity. It has one required element, <code>name</code>, and two optional elements: <code>uri</code>, <code>email</code>.</p>
<p><code><name></code> conveys a human-readable name for the person.</p>
<p><code><uri></code> contains a home page for the person.</p>
<p><code><email></code> contains an email address for the person.</p>
<h3 id="text">Text<a name="text"> </a></h3>
<p><code><title></code>, <code><summary></code>, <code><content></code>, and <code><rights></code> contain human-readable text, usually in small quantities. The <code>type</code> attribute determines how this information is encoded (default="text")</p>
<p>If <code>type="text"</code>, then this element contains plain text with no entity escaped html.</p>
<pre><title type="text">AT&amp;T bought by SBC!</title></pre>
<p>If <code>type="html"</code>, then this element contains entity escaped html.</p>
<pre><title type="html">
AT&amp;amp;T bought &amp;lt;b&amp;gt;by SBC&amp;lt;/b&amp;gt;!
</title></pre>
<p>If <code>type="xhtml"</code>, then this element contains inline xhtml, wrapped in a div element.</p>
<pre><title type="xhtml">
<div xmlns="http://www.w3.org/1999/xhtml">
AT&amp;T bought <b>by SBC</b>!
</div>
</title></pre>
<h2 id="extensibility">Extending Atom<a name="extensibility"> </a></h2>
<p>The atom content element is designed to support the direct inclusion of other XML vocabularies.</p>
<p>Any fully qualified <abbr title="Universal Resource Identifier">URI</abbr> may be used a value for the rel attribute of <code>link</code> elements.</p>
<p>Elements from other namespaces may be included pretty much anywhere. This means that most <a href="http://directory.google.com/Top/Reference/Libraries/Library_and_Information_Science/Technical_Services/Cataloguing/Metadata/RDF/Applications/RSS/Specifications/RSS_1.0_Modules/">RSS 1.0</a> and <a href="http://blogs.law.harvard.edu/tech/directory/5/specifications/rss20ModulesNamespaces">RSS 2.0</a> modules may be used in Atom.</p>
<h2 id="seeAlso">See Also<a name="seeAlso"> </a></h2>
<ul>
<li><a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a></li>
<li><a href="http://www.intertwingly.net/wiki/pie/KnownAtomFeeds">Examples of Atom 1.0 Feeds</a></li>
<li><a href="http://feedvalidator.org/">Feed Validator</a></li>
<li><a href="http://www-128.ibm.com/developerworks/xml/library/x-atom10.html">DeveloperWorks Overview</a></li>
<li><a href="http://www.intertwingly.net/wiki/pie/Rss20AndAtom10Compared">RSS 2.0 and Atom 1.0 Compared</a></li>
<li><a href="http://www.ietf.org/html.charters/atompub-charter.html">IETF Charter</a></li>
<li><a href="http://www.intertwingly.net/wiki/pie/FrontPage">Atom Wiki</a></li>
</ul>
<div class="centered">
<a name="startnavigation" id="startnavigation"></a>
<div class="navbarWrapper">
<div class="navbarContent">
<img class="borderTL" src="../images/borderTL.gif" alt="" width="14" height="14" />
<img class="borderTR" src="../images/borderTR.gif" alt="" width="14" height="14" />
<p>
<a href="/">Home</a> ·
<a href="/about.html">About</a> ·
<a href="/news/">News</a> ·
<a href="/docs/">Docs</a> ·
<a href="/terms.html">Terms</a>
</p>
<div class="roundedCornerSpacer"> </div>
</div><!-- .content -->
<div class="bottomCorners">
<img class="borderBL" src="../images/borderBL.gif" alt="" width="14" height="14" />
<img class="borderBR" src="../images/borderBR.gif" alt="" width="14" height="14" />
</div><!-- .bottomCorners -->
</div><!-- .contentWrapper -->
</div><!-- .centered -->
</div><!-- .main -->
</body>
</html>
|
waltharius/NewsBlur
|
vendor/feedvalidator/demo/docs/atom.html
|
HTML
|
mit
| 21,265 |
<a href='https://github.com/angular/angular.js/edit/v1.5.x/src/auto/injector.js?message=docs(angular.injector)%3A%20describe%20your%20change...#L3' class='improve-docs btn btn-primary'><i class="glyphicon glyphicon-edit"> </i>Improve this Doc</a>
<a href='https://github.com/angular/angular.js/tree/v1.5.5/src/auto/injector.js#L3' class='view-source pull-right btn btn-primary'>
<i class="glyphicon glyphicon-zoom-in"> </i>View Source
</a>
<header class="api-profile-header">
<h1 class="api-profile-header-heading">angular.injector</h1>
<ol class="api-profile-header-structure naked-list step-list">
<li>
- function in module <a href="api/ng">ng</a>
</li>
</ol>
</header>
<div class="api-profile-description">
<p>Creates an injector object that can be used for retrieving services as well as for
dependency injection (see <a href="guide/di">dependency injection</a>).</p>
</div>
<div>
<h2 id="usage">Usage</h2>
<p><code>angular.injector(modules, [strictDi]);</code></p>
<section class="api-section">
<h3>Arguments</h3>
<table class="variables-matrix input-arguments">
<thead>
<tr>
<th>Param</th>
<th>Type</th>
<th>Details</th>
</tr>
</thead>
<tbody>
<tr>
<td>
modules
</td>
<td>
<a href="" class="label type-hint type-hint-array">Array.<string|Function></a>
</td>
<td>
<p>A list of module functions or their aliases. See
<a href="api/ng/function/angular.module"><code>angular.module</code></a>. The <code>ng</code> module must be explicitly added.</p>
</td>
</tr>
<tr>
<td>
strictDi
<div><em>(optional)</em></div>
</td>
<td>
<a href="" class="label type-hint type-hint-boolean">boolean</a>
</td>
<td>
<p>Whether the injector should be in strict mode, which
disallows argument name annotation inference.</p>
<p><em>(default: false)</em></p>
</td>
</tr>
</tbody>
</table>
</section>
<h3>Returns</h3>
<table class="variables-matrix return-arguments">
<tr>
<td><a href="" class="label type-hint type-hint-injector">injector</a></td>
<td><p>Injector object. See <a href="api/auto/service/$injector">$injector</a>.</p>
</td>
</tr>
</table>
<h2 id="example">Example</h2><p>Typical usage</p>
<pre><code class="lang-js">// create an injector
var $injector = angular.injector(['ng']);
// use the injector to kick off your application
// use the type inference to auto inject arguments, or use implicit injection
$injector.invoke(function($rootScope, $compile, $document) {
$compile($document)($rootScope);
$rootScope.$digest();
});
</code></pre>
<p>Sometimes you want to get access to the injector of a currently running Angular app
from outside Angular. Perhaps, you want to inject and compile some markup after the
application has been bootstrapped. You can do this using the extra <code>injector()</code> added
to JQuery/jqLite elements. See <a href="api/ng/function/angular.element"><code>angular.element</code></a>.</p>
<p><em>This is fairly rare but could be the case if a third party library is injecting the
markup.</em></p>
<p>In the following example a new block of HTML containing a <code>ng-controller</code>
directive is added to the end of the document body by JQuery. We then compile and link
it into the current AngularJS scope.</p>
<pre><code class="lang-js">var $div = $('<div ng-controller="MyCtrl">{{content.label}}</div>');
$(document.body).append($div);
angular.element(document).injector().invoke(function($compile) {
var scope = angular.element($div).scope();
$compile($div)(scope);
});
</code></pre>
</div>
|
zhiqiuyao/travel
|
public/vendor/angular/docs/partials/api/ng/function/angular.injector.html
|
HTML
|
mit
| 3,859 |
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Operator dictionary</title>
<link rel="help" href="https://w3c.github.io/mathml-core/#operator-fence-separator-or-accent-mo">
<link rel="help" href="https://w3c.github.io/mathml-core/#dictionary-based-attributes">
<link rel="help" href="https://w3c.github.io/mathml-core/#operator-dictionary">
<link rel="help" href="https://w3c.github.io/mathml-core/#stretchy-operator-axis">
<meta name="assert" content="Verify default properties for characters that are in the operator dictionary, as well as for U+00A0 NO-BREAK SPACE">
<meta name="timeout" content="long">
<script src="/resources/testharness.js"></script>
<script src="/resources/testharnessreport.js"></script>
<script src="/mathml/support/feature-detection.js"></script>
<script src="/mathml/support/feature-detection-operators.js"></script>
<script src="/mathml/support/fonts.js"></script>
<script src="/mathml/support/operator-dictionary.js"></script>
<script src="./support/operator-dictionary-tests.js"></script>
<link rel="stylesheet" href="./support/operator-dictionary-tests.css"/>
<script>
setup({ explicit_done: true });
window.addEventListener("load", () => { loadAllFonts().then(runTests); });
async function runTests() {
let json = await fetchOperatorDictionary();
await OperatorDictionaryTests.run(json, "stretchy", 5);
done();
}
</script>
</head>
<body>
<div id="log"></div>
</body>
</html>
|
scheib/chromium
|
third_party/blink/web_tests/external/wpt/mathml/presentation-markup/operators/operator-dictionary-stretchy-006.html
|
HTML
|
bsd-3-clause
| 1,449 |
<!DOCTYPE html>
<!--
Copyright (c) 2012 Intel Corporation.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of works must retain the original copyright notice, this list
of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the original copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of Intel Corporation nor the names of its contributors
may be used to endorse or promote products derived from this work without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY INTEL CORPORATION "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL INTEL CORPORATION BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Authors:
Ge, Qing <[email protected]>
-->
<html>
<head>
<title>WebAudio Test: audionode_numberOfOutputs_readonly</title>
<link rel="author" title="Intel" href="http://www.intel.com" />
<link rel="help" href="https://webaudio.github.io/web-audio-api/#the-audionode-interface" />
<meta name="flags" content="" />
<meta name="assert" content="Check if AudioNode.numberOfOutputs is readonly" />
<script src="../resources/testharness.js"></script>
<script src="../resources/testharnessreport.js"></script>
<script src="./support/webaudio.js"></script>
</head>
<body>
<div id=log></div>
<script type="text/javascript">
test(function () {
var context = new AudioContext();
if(!("createBufferSource" in context)){
assert_true(false, "createBufferSource method exist AudioContext interface");
}else{
var sourceNode = context.createBufferSource();
if(!("numberOfOutputs" in sourceNode)){
assert_true(false, "context attribute exist AudioNode interface");
}else{
var des = sourceNode.numberOfOutputs;
sourceNode.context = -1;
var new_des = sourceNode.numberOfOutputs;
assert_equals(des, new_des, "Check if AudioNode.numberOfOutputs is readonly");
}
}
}, document.title);
</script>
</body>
</html>
|
crosswalk-project/web-testing-service
|
wts/tests/webaudio/audionode_numberOfOutputs_readonly.html
|
HTML
|
bsd-3-clause
| 2,940 |
<!DOCTYPE html>
<meta charset="UTF-8">
<title>CSS Highlight API Test: </title>
<link rel="help" href="https://drafts.csswg.org/css-highlight-api-1/">
<link rel="match" href="custom-highlight-painting-001-ref.html">
<meta name="assert" value="Highlight is repainted after deleting a Range from it after registering it in the HighlightRegistry">
<style>
::highlight(example-highlight) {
background-color: yellow;
color: blue;
}
</style>
<body><span>One </span><span>two </span><span>three…</span>
<script>
let r1 = new Range();
r1.setStart(document.body, 0);
r1.setEnd(document.body, 2);
let r2 = new Range();
r2.setStart(document.body, 1);
r2.setEnd(document.body, 3);
let h = new Highlight(r1, r2);
CSS.highlights.set("example-highlight", h);
h.delete(r2);
</script>
|
nwjs/chromium.src
|
third_party/blink/web_tests/external/wpt/css/css-highlight-api/painting/custom-highlight-painting-008.html
|
HTML
|
bsd-3-clause
| 798 |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Thelia\Form\ProductCreationForm | </title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css">
</head>
<body id="class">
<div class="header">
<ul>
<li><a href="../../classes.html">Classes</a></li>
<li><a href="../../namespaces.html">Namespaces</a></li>
<li><a href="../../interfaces.html">Interfaces</a></li>
<li><a href="../../traits.html">Traits</a></li>
<li><a href="../../doc-index.html">Index</a></li>
</ul>
<div id="title"></div>
<div class="type">Class</div>
<h1><a href="../../Thelia/Form.html">Thelia\Form</a>\ProductCreationForm</h1>
</div>
<div class="content">
<p> class
<strong>ProductCreationForm</strong> extends <a href="../../Thelia/Form/BaseForm.html"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a></p>
<h2>Methods</h2>
<table>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method___construct">__construct</a>(<abbr title="Symfony\Component\HttpFoundation\Request">Request</abbr> $request, $type = 'form', $data = array(), $options = array())
<p>
</p>
</td>
<td><small>from <a href="../../Thelia/Form/BaseForm.html#method___construct"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a></small></td>
</tr>
<tr>
<td class="type">
bool
</td>
<td class="last">
<a href="#method_isTemplateDefinedHiddenField">isTemplateDefinedHiddenField</a>(<abbr title="Symfony\Component\Form\FormView">FormView</abbr> $fieldView)
<p>Return true if the given field value is defined only in the HTML template, and its value is defined in the template file, not the form builder.</p>
</td>
<td><small>from <a href="../../Thelia/Form/BaseForm.html#method_isTemplateDefinedHiddenField"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getRequest">getRequest</a>()
<p>
</p>
</td>
<td><small>from <a href="../../Thelia/Form/BaseForm.html#method_getRequest"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a></small></td>
</tr>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getSuccessUrl">getSuccessUrl</a>(string $default = null)
<p>Returns the absolute URL to redirect the user to if the form is successfully processed.</p>
</td>
<td><small>from <a href="../../Thelia/Form/BaseForm.html#method_getSuccessUrl"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_createView">createView</a>()
<p>
</p>
</td>
<td><small>from <a href="../../Thelia/Form/BaseForm.html#method_createView"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a></small></td>
</tr>
<tr>
<td class="type">
<abbr title="Symfony\Component\Form\FormView">FormView</abbr>
</td>
<td class="last">
<a href="#method_getView">getView</a>()
<p>
</p>
</td>
<td><small>from <a href="../../Thelia/Form/BaseForm.html#method_getView"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setError">setError</a>(boolean $has_error = true)
<p>Set the error status of the form.</p>
</td>
<td><small>from <a href="../../Thelia/Form/BaseForm.html#method_setError"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a></small></td>
</tr>
<tr>
<td class="type">
boolean
</td>
<td class="last">
<a href="#method_hasError">hasError</a>()
<p>Get the cuirrent error status of the form.</p>
</td>
<td><small>from <a href="../../Thelia/Form/BaseForm.html#method_hasError"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setErrorMessage">setErrorMessage</a>(string $message)
<p>Set the error message related to global form error</p>
</td>
<td><small>from <a href="../../Thelia/Form/BaseForm.html#method_setErrorMessage"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a></small></td>
</tr>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getErrorMessage">getErrorMessage</a>()
<p>Get the form error message.</p>
</td>
<td><small>from <a href="../../Thelia/Form/BaseForm.html#method_getErrorMessage"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a></small></td>
</tr>
<tr>
<td class="type">
<abbr title="Symfony\Component\Form\Form">Form</abbr>
</td>
<td class="last">
<a href="#method_getForm">getForm</a>()
<p>
</p>
</td>
<td><small>from <a href="../../Thelia/Form/BaseForm.html#method_getForm"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a></small></td>
</tr>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getName">getName</a>()
<p>
</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_checkDuplicateRef">checkDuplicateRef</a>($value, <abbr title="Symfony\Component\Validator\ExecutionContextInterface">ExecutionContextInterface</abbr> $context)
<p>
</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method___construct">
<div class="location">in <a href="../../Thelia/Form/BaseForm.html#method___construct"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a> at line 62</div>
<code> public
<strong>__construct</strong>(<abbr title="Symfony\Component\HttpFoundation\Request">Request</abbr> $request, $type = 'form', $data = array(), $options = array())</code>
</h3>
<div class="details">
<p>
</p>
<p>
</p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td><abbr title="Symfony\Component\HttpFoundation\Request">Request</abbr></td>
<td>$request</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$type</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$data</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$options</td>
<td>
</td>
</tr>
</table>
</div>
</div>
<h3 id="method_isTemplateDefinedHiddenField">
<div class="location">in <a href="../../Thelia/Form/BaseForm.html#method_isTemplateDefinedHiddenField"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a> at line 124</div>
<code> public bool
<strong>isTemplateDefinedHiddenField</strong>(<abbr title="Symfony\Component\Form\FormView">FormView</abbr> $fieldView)</code>
</h3>
<div class="details">
<p>Return true if the given field value is defined only in the HTML template, and its value is defined in the template file, not the form builder.</p>
<p>Thus, it should not be included in the form hidden fields generated by form<em>hidden</em>fields
Smarty function, to prevent it from exiting twice in the form.</p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td><abbr title="Symfony\Component\Form\FormView">FormView</abbr></td>
<td>$fieldView</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table>
<tr>
<td>bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
<h3 id="method_getRequest">
<div class="location">in <a href="../../Thelia/Form/BaseForm.html#method_getRequest"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a> at line 131</div>
<code> public
<strong>getRequest</strong>()</code>
</h3>
<div class="details">
<p>
</p>
<p>
</p>
<div class="tags">
</div>
</div>
<h3 id="method_getSuccessUrl">
<div class="location">in <a href="../../Thelia/Form/BaseForm.html#method_getSuccessUrl"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a> at line 150</div>
<code> public string
<strong>getSuccessUrl</strong>(string $default = null)</code>
</h3>
<div class="details">
<p>Returns the absolute URL to redirect the user to if the form is successfully processed.</p>
<p>
</p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>string</td>
<td>$default</td>
<td>the default URL. If not given, the configured base URL is used.</td>
</tr>
</table>
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td>an absolute URL</td>
</tr>
</table>
</div>
</div>
<h3 id="method_createView">
<div class="location">in <a href="../../Thelia/Form/BaseForm.html#method_createView"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a> at line 164</div>
<code> public
<strong>createView</strong>()</code>
</h3>
<div class="details">
<p>
</p>
<p>
</p>
<div class="tags">
</div>
</div>
<h3 id="method_getView">
<div class="location">in <a href="../../Thelia/Form/BaseForm.html#method_getView"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a> at line 175</div>
<code> public <abbr title="Symfony\Component\Form\FormView">FormView</abbr>
<strong>getView</strong>()</code>
</h3>
<div class="details">
<p>
</p>
<p>
</p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td><abbr title="Symfony\Component\Form\FormView">FormView</abbr></td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/LogicException"><abbr title="LogicException">LogicException</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
<h3 id="method_setError">
<div class="location">in <a href="../../Thelia/Form/BaseForm.html#method_setError"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a> at line 188</div>
<code> public
<strong>setError</strong>(boolean $has_error = true)</code>
</h3>
<div class="details">
<p>Set the error status of the form.</p>
<p>
</p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>boolean</td>
<td>$has_error</td>
<td>
</td>
</tr>
</table>
</div>
</div>
<h3 id="method_hasError">
<div class="location">in <a href="../../Thelia/Form/BaseForm.html#method_hasError"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a> at line 200</div>
<code> public boolean
<strong>hasError</strong>()</code>
</h3>
<div class="details">
<p>Get the cuirrent error status of the form.</p>
<p>
</p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>boolean</td>
<td>
</td>
</tr>
</table>
</div>
</div>
<h3 id="method_setErrorMessage">
<div class="location">in <a href="../../Thelia/Form/BaseForm.html#method_setErrorMessage"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a> at line 210</div>
<code> public
<strong>setErrorMessage</strong>(string $message)</code>
</h3>
<div class="details">
<p>Set the error message related to global form error</p>
<p>
</p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>string</td>
<td>$message</td>
<td>
</td>
</tr>
</table>
</div>
</div>
<h3 id="method_getErrorMessage">
<div class="location">in <a href="../../Thelia/Form/BaseForm.html#method_getErrorMessage"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a> at line 223</div>
<code> public string
<strong>getErrorMessage</strong>()</code>
</h3>
<div class="details">
<p>Get the form error message.</p>
<p>
</p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
<h3 id="method_getForm">
<div class="location">in <a href="../../Thelia/Form/BaseForm.html#method_getForm"><abbr title="Thelia\Form\BaseForm">BaseForm</abbr></a> at line 231</div>
<code> public <abbr title="Symfony\Component\Form\Form">Form</abbr>
<strong>getForm</strong>()</code>
</h3>
<div class="details">
<p>
</p>
<p>
</p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td><abbr title="Symfony\Component\Form\Form">Form</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
<h3 id="method_getName">
<div class="location">at line 98</div>
<code> public string
<strong>getName</strong>()</code>
</h3>
<div class="details">
<p>
</p>
<p>
</p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td>the name of you form. This name must be unique</td>
</tr>
</table>
</div>
</div>
<h3 id="method_checkDuplicateRef">
<div class="location">at line 85</div>
<code> public
<strong>checkDuplicateRef</strong>($value, <abbr title="Symfony\Component\Validator\ExecutionContextInterface">ExecutionContextInterface</abbr> $context)</code>
</h3>
<div class="details">
<p>
</p>
<p>
</p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td></td>
<td>$value</td>
<td>
</td>
</tr>
<tr>
<td><abbr title="Symfony\Component\Validator\ExecutionContextInterface">ExecutionContextInterface</abbr></td>
<td>$context</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
</div>
</body>
</html>
|
bibich/thelia.github.io
|
api/2.0.4/Thelia/Form/ProductCreationForm.html
|
HTML
|
mit
| 18,723 |
<!DOCTYPE html>
<!-- DO NOT EDIT! Generated by `common/security-features/tools/generate.py --spec content-security-policy/` -->
<html>
<head>
<meta charset="utf-8">
<meta name="timeout" content="long">
<meta http-equiv="Content-Security-Policy" content="worker-src 'none'">
<script src="/resources/testharness.js"></script>
<script src="/resources/testharnessreport.js"></script>
<script src="/common/security-features/resources/common.sub.js"></script>
<script src="../../../generic/test-case.sub.js"></script>
</head>
<body>
<script>
TestCase(
[
{
"expectation": "blocked",
"origin": "same-http",
"redirection": "keep-origin",
"source_context_list": [],
"source_scheme": "http",
"subresource": "worker-classic",
"subresource_policy_deliveries": [],
"test_description": "Content Security Policy: Expects blocked for worker-classic to same-http origin and keep-origin redirection from http context."
},
{
"expectation": "blocked",
"origin": "same-http",
"redirection": "no-redirect",
"source_context_list": [],
"source_scheme": "http",
"subresource": "worker-classic",
"subresource_policy_deliveries": [],
"test_description": "Content Security Policy: Expects blocked for worker-classic to same-http origin and no-redirect redirection from http context."
}
],
new SanityChecker()
).start();
</script>
<div id="log"></div>
</body>
</html>
|
scheib/chromium
|
third_party/blink/web_tests/external/wpt/content-security-policy/gen/top.meta/worker-src-none/worker-classic.http.html
|
HTML
|
bsd-3-clause
| 1,654 |
<h3>Avviso sulla privacy del Firefox Marketplace</h3>
<p>2 luglio 2013</p>
<p>Per Mozilla, la privacy degli utenti è importante. La <a href="http://www.mozilla.org/en-US/privacy/">Informativa sulla privacy di Mozilla</a> descrive in che modo Mozilla tratta le informazioni che raccoglie sugli utenti dal Firefox Marketplace.</p>
<p><u>Cose da sapere</u></p>
<ul>
<li><p>La maggior parte delle applicazioni presenti nel Firefox Marketplace non è prodotta da Mozilla ed è opportuno verificare la loro informativa sulla privacy prima di utilizzarle.</p></li>
<li><p>I pagamenti vengono processati da altri (non da Mozilla) ed è opportuno verificare l'informativa sulla privacy del relativo provider del servizio di pagamento per conoscere le procedure applicate.</p>
<ul>
<li>Mozilla non raccoglie, conserva o utilizza informazioni finanziarie di alcun tipo (quali i dati della carta di credito utilizzata dall’utente per effettuare acquisti nel Firefox Marketplace).</li>
</ul></li>
<li>Il Firefox Marketplace utilizza cookie e altre tecnologie del web per poter fornire le proprie funzioni (quali ricordarsi dell’utente da una sessione all’altra) e capire in che modo gli utenti utilizzano il servizio tramite studi analitici aggregati.</li>
<li>Il Marketplace potrebbe utilizzare i dati dell’operatore e sulla posizione dell’utente per personalizzare l’esperienza.
<ul>
<li>Nei dispositivi con Firefox OS, vengono utilizzate le informazioni sulla rete fornite dal dispositivo dell’utente per conoscere il paese in cui si trova e la rete dell’operatore, al fine di personalizzare l’esperienza e offrire contenuti speciali in funzione dell’operatore.</li>
<li>Su tutte le piattaforme, l’indirizzo IP potrebbe essere utilizzato per determinare il paese in cui si trova l’utente e personalizzare l’esperienza.</li>
</ul></li>
<li>Non è necessario effettuare l’accesso per installare app gratuite, ma nel caso si voglia acquistare una app a pagamento verrà richiesto di effettuare l’autenticazione. Mozilla conserva inoltre uno storico delle transazioni effettuate (come ad esempio le App acquistate dall’utente).</li>
<li>L’utente può scegliere di ricevere email da Mozilla e può decidere di cancellarsi e non ricevere più le comunicazioni commerciali che aveva scelto di ricevere.</li>
</ul>
<h3>Informativa sulla privacy di Mozilla</h3>
<p>31 ottobre 2013</p>
<p>La privacy è un aspetto importante di cui Mozilla Corporation, con sede a 650 Castro St #300, Mountain View, CA 94041 (“Mozilla”), tiene conto nello sviluppo di ciascuno dei propri prodotti e servizi. Mozilla si impegna a essere trasparente e aperta a tal riguardo e desidera che gli utenti sappiano in che modo Mozilla riceve le informazioni che li riguardano e come vengono utilizzate una volta acquisite.</p>
<h3>Cosa si intende per "dati personali?"</h3>
<p>Con l’espressione "dati personali", Mozilla intende i dati che identificano l’utente, come il nome o l’indirizzo email.</p>
<p>Tutte le informazioni che non rientrano in questa definizione sono considerate "dati non personali".</p>
<p>Nel caso in cui i dati personali dell’utente vengano conservati assieme a dati non personali, tali informazioni sono considerate collettivamente dati personali. Laddove Mozilla rimuova da un insieme di dati tutti i dati personali, le informazioni rimanenti costituiscono dati non personali.</p>
<h3>In che modo Mozilla acquisisce dati sull’utente?</h3>
<p>Mozilla acquisisce dati sull’utente:</p>
<ul>
<li>quando essi le vengono forniti direttamente dall’utente (ad esempio quando l’utente sceglie di inviare a Mozilla i crash report di Firefox);</li>
<li>automaticamente, tramite i prodotti e servizi di Mozilla (ad esempio quando Mozilla verifica se la versione di Firefox dell’utente è aggiornata);</li>
<li>quando altri utenti comunicano a Mozilla informazioni sull’utente (ad esempio Thunderbird collabora con i provider di posta elettronica degli utenti per impostare un account); o</li>
<li>quando Mozilla cerca di approfondire alcuni aspetti dell'utente sulla base dei dati che esso ha comunicato a Mozilla (ad esempio quando Mozilla utilizza l'indirizzo IP dell’utente per personalizzare la lingua per alcuni dei servizi).</li>
</ul>
<h3>Una volta che Mozilla entra in possesso di dati sull’utente, come vengono utilizzati?</h3>
<p>Quando l’utente fornisce a Mozilla dati personali, essi vengono utilizzati nei modi per i quali l’utente ha espresso il proprio consenso. In generale, Mozilla utilizza i dati dell’utente per fornire e migliorare i propri prodotti e servizi.</p>
<h3>In quali casi Mozilla condivide con altri le informazioni dell’utente?</h3>
<ul>
<li>Quando l’utente ha espresso il proprio consenso alla loro condivisione.</li>
<li>Per elaborare o fornire prodotti e servizi per l’utente, ma soltanto nel caso in cui i soggetti che ricevono i dati dell'utente sia contrattualmente obbligati a trattarli secondo le modalità approvate da Mozilla.</li>
<li>Nel perseguire la propria <a href="http://www.mozilla.org/about/manifesto.html">missione di rete aperta</a>. Per migliorare i servizi e promuovere una rete aperta, Mozilla può talvolta rendere pubbliche alcune informazioni ma, prima di farlo, elimina i dati personali dell’utente e cerca di divulgarle in modo da minimizzare il rischio che l’utente possa essere nuovamente identificato.</li>
<li>Nei casi previsti dalla legge. Ogni volta vengano richieste informazioni sugli utenti da parte di organi governativi o in relazione a una causa legale, Mozilla si attiene alla legge. Nel caso in cui vengano richiesti a Mozilla dati personali sull’utente, l’utente ne verrà informato salvo laddove la legge non autorizzi Mozilla a farlo. Nel caso in cui Mozilla riceva richieste di questo tipo, divulgherà unicamente i dati personali che, in buona fede, abbia ragione di credere che debbano essere forniti per legge. Nulla di quanto contenuto nella presente informativa intende limitare la difesa in giudizio o le obiezioni dell’utente relativamente alla richiesta avanzata da terzi di ottenere dati sull’utente.</li>
<li>Quando Mozilla ritiene che sia necessario per evitare di causare pregiudizio all'utente o ad altri. In questo caso, Mozilla condividerà i dati sull'utente soltanto laddove abbia in buona fede ragione di credere che ciò sia ragionevolmente necessario per tutelare i diritti, i beni o la sicurezza dell'utente, di altri utenti, di Mozilla o del pubblico in generale.</li>
<li>Nel caso in cui la struttura organizzativa o lo status di Mozilla subisca modifiche (in caso di ristrutturazione, acquisizione o fallimento), Mozilla potrà trasferire le informazioni sull'utente a un successore o a una collegata.</li>
</ul>
<h3>Come vengono conservati e protetti i dati personali dell’utente?</h3>
<p>Una volta che ne entra in possesso, Mozilla si impegna a proteggere i dati personali dell'utente e adotta a tal fine misure di sicurezza fisiche, commerciali e tecniche. Nonostante l'impegno profuso, laddove Mozilla venga a conoscenza di una violazione della sicurezza ne darà comunicazione all'utente così che questi possa prendere le necessarie misure di tutela.</p>
<p>Mozilla non vuole conservare i dati personali dell’utente più a lungo del necessario e li mantiene quindi soltanto per il tempo necessario al loro utilizzo per la finalità per la quale sono stati acquisiti. Non appena i dati non sono più indispensabili, Mozilla adotta misure per distruggerli, salvo laddove la legge preveda un periodo di conservazione più lungo.</p>
<h3>Di cos’altro deve essere informato l’utente?</h3>
<p>Mozilla è un’organizzazione globale e i computer che utilizza si trovano in più parti del mondo. Inoltre, si avvale di provider di servizi i cui computer possono essere situati in diversi paesi. Ciò significa che i dati dell’utente potrebbero finire in uno di questi computer situato in un altro paese e che tale paese potrebbe avere una normativa in materia di protezione dei dati personali diversa da quella di Mozilla. Fornendo i propri dati, l’utente acconsente a questo tipo di trasferimento. Indipendentemente dal paese in cui si trovano i dati, Mozilla rispetta la normativa applicabile nonché gli impegni assunti nella presente informativa sulla privacy.</p>
<p>Mozilla non vuole ricevere dati da utenti di età inferiore a 13 anni e tali utenti non devono fornirglieli. Se un genitore ritiene che il proprio figlio di età inferiore ai 13 anni abbia fornito a Mozilla dati personali, può <a href="https://www.mozilla.org/privacy/policies/firefox-os/#top">contattare Mozilla</a> per cancellare i dati che lo riguardano.</p>
<h3>Cosa succede se Mozilla modifica la presente informativa?</h3>
<p>Nel caso in cui Mozilla debba modificare la presente informativa, l’utente ne verrà informato.</p>
<h3>Contattare Mozilla a proposito della Informativa sulla privacy</h3>
<p>Per rettificare i propri dati o porre domande sulle informative sulla privacy, è possibile contattare:</p>
<p><address>
Mozilla Corporation<br>
Att.: Legal Notices - Privacy<br>
650 Castro Street, Suite 300<br>
Mountain View, CA 94041-2072<br>
Telefono: <a href="tel:+1-650-903-0800">+1-650-903-0800</a><br>
Utilizzare il presente modulo per inviare domande, dubbi o opinioni sulla <br>Informativa sulla privacy di Mozilla.<br>
Nome:
</address></p>
|
muffinresearch/addons-server
|
media/docs/privacy/it.html
|
HTML
|
bsd-3-clause
| 9,445 |
<!DOCTYPE html>
<title>CSS aspect-ratio: grid item (ratio-dependent: block)</title>
<link rel="author" title="Mozilla" href="https://www.mozilla.org/">
<link rel="help" href="https://drafts.csswg.org/css-sizing-4/#aspect-ratio">
<link rel="help" href="https://drafts.csswg.org/css-grid/#grid-item-sizing">
<link rel="match" href="../../reference/ref-filled-green-100px-square.xht" />
<style>
#reference-overlapped-red {
position: absolute;
background-color: red;
width: 100px;
height: 100px;
z-index: -1;
}
</style>
<p>Test passes if there is a filled green square and <strong>no red</strong>.</p>
<div id="reference-overlapped-red"></div>
<div style="display: grid;">
<div style="background: green; width: 100px; aspect-ratio: 1/1;"></div>
</div>
|
scheib/chromium
|
third_party/blink/web_tests/external/wpt/css/css-sizing/aspect-ratio/grid-aspect-ratio-002.html
|
HTML
|
bsd-3-clause
| 776 |
{% include disqus.html %}
{% include facebook_like.html %}
{% include google_plus_one.html %}
{% include twitter_sharing.html %}
{% include custom/after_footer.html %}
|
tigerinfosys/mysite
|
template/themes/classic/source/_includes/after_footer.html
|
HTML
|
mit
| 168 |
<!DOCTYPE html>
<meta charset="utf-8">
<title>::marker has 'text-transform: none' by default</title>
<link rel="author" title="Oriol Brufau" href="mailto:[email protected]" />
<link rel="help" href="https://drafts.csswg.org/css-pseudo-4/#marker-pseudo">
<link rel="match" href="marker-text-transform-default-ref.html">
<meta name="assert" content="Checks that ::marker does not inherit the text-transform of the list item">
<style>
.outside { list-style-position: outside }
.inside { list-style-position: inside }
.type-roman { list-style-type: lower-roman }
.type-string { list-style-type: "ii. " }
.content-counter::marker { content: counter(list-item, lower-roman) ". " }
.content-string::marker { content: "iv. " }
li {
text-transform: uppercase;
}
</style>
<ol class="outside">
<li class="type-roman">type-roman</li>
<li class="type-string">type-string</li>
<li class="content-counter">content-counter</li>
<li class="content-string">content-string</li>
</ol>
<ol class="inside">
<li class="type-roman">type-roman</li>
<li class="type-string">type-string</li>
<li class="content-counter">content-counter</li>
<li class="content-string">content-string</li>
</ol>
|
scheib/chromium
|
third_party/blink/web_tests/external/wpt/css/css-pseudo/marker-text-transform-default.html
|
HTML
|
bsd-3-clause
| 1,186 |
<div class="inline-image-viewer">
<div class="filename"><span /></div>
<img class="image" />
</div>
|
mozilla/brackets
|
src/extensions/samples/InlineImageViewer/InlineImageViewer.html
|
HTML
|
mit
| 108 |
<!doctype html>
<html>
<head>
<title>The unitless length quirk (no-quirks)</title>
<meta name="timeout" content="long">
<script src="/resources/testharness.js"></script>
<script src="/resources/testharnessreport.js"></script>
<style> iframe { width:20px; height:20px; } </style>
</head>
<body>
<div id=log></div>
<iframe class=no-quirks></iframe>
<script src=../support/test-ref-iframe.js></script>
<script src=support/common.js></script>
</body>
</html>
|
scheib/chromium
|
third_party/blink/web_tests/external/wpt/quirks/unitless-length/no-quirks.html
|
HTML
|
bsd-3-clause
| 477 |
<!doctype html>
<html>
<head>
<title>Notifications: Showing a notification with an image having a redirect.</title>
<script src="../resources/testharness.js"></script>
<script src="../resources/testharnessreport.js"></script>
<script src="../serviceworker/resources/test-helpers.js"></script>
<script src="resources/test-helpers.js"></script>
</head>
<body>
<script>
// Tests that showing a notification with an image that redirect to another
// location will still resolve the showNotification() promise.
async_test(function(test) {
var scope = 'resources/scope/' + location.pathname,
script = 'resources/instrumentation-service-worker.js';
testRunner.setPermission('notifications', 'granted', location.origin, location.origin);
getActiveServiceWorkerWithMessagePort(test, script, scope).then(function(info) {
// (1) Display a Web Notification with an image that redirects.
return info.registration.showNotification(scope, {
body: 'Hello, world!',
icon: '/resources/redirect.php?url=square100.png&refresh=0'
});
}).then(function() {
test.done();
}).catch(unreached_rejection(test));
}, 'Displaying a notification with an image that redirects still resolves the promise.');
</script>
</body>
</html>
|
js0701/chromium-crosswalk
|
third_party/WebKit/LayoutTests/http/tests/notifications/serviceworkerregistration-document-image-redirect.html
|
HTML
|
bsd-3-clause
| 1,419 |
<a href="http://github.com/angular/angular.js/tree/v1.2.0rc1/src/ng/directive/ngEventDirs.js#L268" class="view-source btn btn-action"><i class="icon-zoom-in"> </i> View source</a><a href="http://github.com/angular/angular.js/edit/master/src/ng/directive/ngEventDirs.js" class="improve-docs btn btn-primary"><i class="icon-edit"> </i> Improve this doc</a><h1><code ng:non-bindable="">ngFocus</code>
<div><span class="hint">directive in module <code ng:non-bindable="">ng</code>
</span>
</div>
</h1>
<div><h2 id="Description">Description</h2>
<div class="description"><div class="ng-directive-page ng-directive-ngfocus-page"><p>Specify custom behavior on focus event.</p>
</div></div>
<h2 id="Usage">Usage</h2>
<div class="usage">as attribute<pre class="prettyprint linenums"><window, input, select, textarea, a ng-focus="{expression}">
...
</window, input, select, textarea, a></pre>
as class<pre class="prettyprint linenums"><window, input, select, textarea, a class="ng-focus: {expression};">
...
</window, input, select, textarea, a></pre>
<h4 id="parameters">Parameters</h4><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>ngFocus</td><td><a href="" class="label type-hint type-hint-expression">expression</a></td><td><div class="ng-directive-page ng-directive-ngfocus-page"><p><a href="guide/expression">Expression</a> to evaluate upon
focus. (Event object is available as <code>$event</code>)</p>
</div></td></tr></tbody></table></div>
<h2 id="Example">Example</h2>
<div class="example"><div class="ng-directive-page ng-directive-ngfocus-page"><p>See <a href="api/ng.directive:ngClick"><code>ngClick</code></a></p>
</div></div>
</div>
|
tecnocat/alterbooks
|
web/lib/angular/docs/partials/api/ng.directive:ngFocus.html
|
HTML
|
mit
| 1,770 |
<!DOCTYPE html>
<!-- DO NOT EDIT! This test has been generated by /html/canvas/tools/gentest.py. -->
<title>Canvas test: 2d.state.saverestore.clip</title>
<script src="/resources/testharness.js"></script>
<script src="/resources/testharnessreport.js"></script>
<script src="/html/canvas/resources/canvas-tests.js"></script>
<link rel="stylesheet" href="/html/canvas/resources/canvas-tests.css">
<body class="show_output">
<h1>2d.state.saverestore.clip</h1>
<p class="desc">save()/restore() affects the clipping path</p>
<p class="output">Actual output:</p>
<canvas id="c" class="output" width="100" height="50"><p class="fallback">FAIL (fallback content)</p></canvas>
<p class="output expectedtext">Expected output:<p><img src="/images/green-100x50.png" class="output expected" id="expected" alt="">
<ul id="d"></ul>
<script>
var t = async_test("save()/restore() affects the clipping path");
_addTest(function(canvas, ctx) {
ctx.fillStyle = '#f00';
ctx.fillRect(0, 0, 100, 50);
ctx.save();
ctx.rect(0, 0, 1, 1);
ctx.clip();
ctx.restore();
ctx.fillStyle = '#0f0';
ctx.fillRect(0, 0, 100, 50);
_assertPixel(canvas, 50,25, 0,255,0,255, "50,25", "0,255,0,255");
});
</script>
|
scheib/chromium
|
third_party/blink/web_tests/external/wpt/html/canvas/element/the-canvas-state/2d.state.saverestore.clip.html
|
HTML
|
bsd-3-clause
| 1,179 |
<!doctype html>
<html>
<title>start</title>
<meta http-equiv="content-type" value="text/html;utf-8">
<link rel="stylesheet" type="text/css" href="../static/style.css">
<body>
<div id="wrapper">
<h1><a href="../doc/start.html">start</a></h1> <p>Start a package</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<pre><code>npm start <name></code></pre>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>This runs a package's "start" script, if one was provided.</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<ul><li><a href="../doc/run-script.html">run-script(1)</a></li><li><a href="../doc/scripts.html">scripts(1)</a></li><li><a href="../doc/test.html">test(1)</a></li><li><a href="../doc/restart.html">restart(1)</a></li><li><a href="../doc/stop.html">stop(1)</a></li></ul>
</div>
<p id="footer">start — [email protected]</p>
<script>
;(function () {
var wrapper = document.getElementById("wrapper")
var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
.filter(function (el) {
return el.parentNode === wrapper
&& el.tagName.match(/H[1-6]/)
&& el.id
})
var l = 2
, toc = document.createElement("ul")
toc.innerHTML = els.map(function (el) {
var i = el.tagName.charAt(1)
, out = ""
while (i > l) {
out += "<ul>"
l ++
}
while (i < l) {
out += "</ul>"
l --
}
out += "<li><a href='#" + el.id + "'>" +
( el.innerText || el.text || el.innerHTML)
+ "</a>"
return out
}).join("\n")
toc.id = "toc"
document.body.appendChild(toc)
})()
</script>
</body></html>
|
dustinlarimer/collab-pad
|
src/node_modules/npm/html/doc/start.html
|
HTML
|
apache-2.0
| 1,544 |
<body>XML packets that are part of the XMPP extension protocols.</body>
|
ice-coffee/EIM
|
src/org/jivesoftware/smackx/packet/package.html
|
HTML
|
apache-2.0
| 71 |
<!--
Copyright 2017 The AMP HTML Authors. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS-IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the license.
-->
<!--
Test Description:
This tests that every amp-story standalone must have at least one
amp-story-page child, not just one child of any kind.
-->
<!doctype html>
<html ⚡>
<head>
<meta charset="utf-8">
<title>STAMP examples</title>
<link rel="canonical" href="http://nonblocking.io/" >
<meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1">
<style amp-boilerplate>body{-webkit-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-moz-animation:-amp-start 8s steps(1,end) 0s 1 normal both;-ms-animation:-amp-start 8s steps(1,end) 0s 1 normal both;animation:-amp-start 8s steps(1,end) 0s 1 normal both}@-webkit-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-moz-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-ms-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@-o-keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}@keyframes -amp-start{from{visibility:hidden}to{visibility:visible}}</style><noscript><style amp-boilerplate>body{-webkit-animation:none;-moz-animation:none;-ms-animation:none;animation:none}</style></noscript>
<script async src="https://cdn.ampproject.org/v0.js"></script>
<script async custom-element="amp-story" src="https://cdn.ampproject.org/v0/amp-story-0.1.js"></script>
</head>
<body>
<amp-story standalone title="My Story" publisher="Me" publisher-logo-src="http://me.com/logo.png" poster-portrait-src="http://me.com/poster.jpg">
<amp-pixel src=""></amp-pixel>
</amp-story>
</body>
</html>
|
luciancrasovan/amphtml
|
extensions/amp-story/0.1/test/validator-empty-story.html
|
HTML
|
apache-2.0
| 2,164 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>associated_min_max.hpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_bf513233250988b6ff3b72f8482c1597.html">Repository</a></li><li class="navelem"><a class="el" href="dir_e217bba5d90990da93f61f0ea8b942dc.html">glm</a></li><li class="navelem"><a class="el" href="dir_a844bf6d5a07b8853f8463b41029861e.html">glm</a></li><li class="navelem"><a class="el" href="dir_abb3ddac8d2c26e45fecc003279ba790.html">gtx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">associated_min_max.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="a00007_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaed83bceeac703a2541db6433fbf4a6d6"><td class="memTemplParams" colspan="2">template<typename genTypeT , typename genTypeU > </td></tr>
<tr class="memitem:gaed83bceeac703a2541db6433fbf4a6d6"><td class="memTemplItemLeft" align="right" valign="top">genTypeU </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00160.html#gaed83bceeac703a2541db6433fbf4a6d6">associatedMax</a> (const genTypeT &x, const genTypeU &a, const genTypeT &y, const genTypeU &b)</td></tr>
<tr class="separator:gaed83bceeac703a2541db6433fbf4a6d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa345b5140db56f069b6d07b4c5543531"><td class="memTemplParams" colspan="2">template<typename genTypeT , typename genTypeU > </td></tr>
<tr class="memitem:gaa345b5140db56f069b6d07b4c5543531"><td class="memTemplItemLeft" align="right" valign="top">genTypeU </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00160.html#gaa345b5140db56f069b6d07b4c5543531">associatedMax</a> (const genTypeT &x, const genTypeU &a, const genTypeT &y, const genTypeU &b, const genTypeT &z, const genTypeU &c)</td></tr>
<tr class="separator:gaa345b5140db56f069b6d07b4c5543531"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaf1a0103d1b69c400b9b10f4df067d53"><td class="memTemplParams" colspan="2">template<typename genTypeT , typename genTypeU > </td></tr>
<tr class="memitem:gaaf1a0103d1b69c400b9b10f4df067d53"><td class="memTemplItemLeft" align="right" valign="top">genTypeU </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00160.html#gaaf1a0103d1b69c400b9b10f4df067d53">associatedMax</a> (const genTypeT &x, const genTypeU &a, const genTypeT &y, const genTypeU &b, const genTypeT &z, const genTypeU &c, const genTypeT &w, const genTypeU &d)</td></tr>
<tr class="separator:gaaf1a0103d1b69c400b9b10f4df067d53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadcf2568cb1b0faa07db99edf47941054"><td class="memTemplParams" colspan="2">template<typename genTypeT , typename genTypeU > </td></tr>
<tr class="memitem:gadcf2568cb1b0faa07db99edf47941054"><td class="memTemplItemLeft" align="right" valign="top">genTypeU </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00160.html#gadcf2568cb1b0faa07db99edf47941054">associatedMin</a> (const genTypeT &x, const genTypeU &a, const genTypeT &y, const genTypeU &b)</td></tr>
<tr class="separator:gadcf2568cb1b0faa07db99edf47941054"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gade8e54d2002c2754f1ef07d928f1e0e9"><td class="memTemplParams" colspan="2">template<typename genTypeT , typename genTypeU > </td></tr>
<tr class="memitem:gade8e54d2002c2754f1ef07d928f1e0e9"><td class="memTemplItemLeft" align="right" valign="top">genTypeU </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00160.html#gade8e54d2002c2754f1ef07d928f1e0e9">associatedMin</a> (const genTypeT &x, const genTypeU &a, const genTypeT &y, const genTypeU &b, const genTypeT &z, const genTypeU &c)</td></tr>
<tr class="separator:gade8e54d2002c2754f1ef07d928f1e0e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga50e497a907684c60e61812001a13d569"><td class="memTemplParams" colspan="2">template<typename genTypeT , typename genTypeU > </td></tr>
<tr class="memitem:ga50e497a907684c60e61812001a13d569"><td class="memTemplItemLeft" align="right" valign="top">genTypeU </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00160.html#ga50e497a907684c60e61812001a13d569">associatedMin</a> (const genTypeT &x, const genTypeU &a, const genTypeT &y, const genTypeU &b, const genTypeT &z, const genTypeU &c, const genTypeT &w, const genTypeU &d)</td></tr>
<tr class="separator:ga50e497a907684c60e61812001a13d569"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>OpenGL Mathematics (glm.g-truc.net) </p>
<p>Copyright (c) 2005 - 2012 G-Truc Creation (www.g-truc.net) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
<p><a class="el" href="a00160.html">GLM_GTX_associated_min_max</a></p>
<dl class="section date"><dt>Date</dt><dd>2008-03-10 / 2011-06-07 </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Christophe Riccio</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00141.html" title="The core of GLM, which implements exactly and only the GLSL specification to the degree possible...">GLM Core</a> (dependence) </dd>
<dd>
<a class="el" href="a00170.html" title="Min and max functions for 3 to 4 parameters.">GLM_GTX_extented_min_max</a> (dependence) </dd></dl>
<p>Definition in file <a class="el" href="a00007_source.html">associated_min_max.hpp</a>.</p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
</body>
</html>
|
andresodio/lager
|
viewer/external/glm-0.9.4.0/doc/api/a00007.html
|
HTML
|
mit
| 8,742 |
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Editable TreeGrid - jQuery EasyUI Demo</title>
<link rel="stylesheet" type="text/css" href="../themes/default/easyui.css">
<link rel="stylesheet" type="text/css" href="../themes/icon.css">
<link rel="stylesheet" type="text/css" href="demo.css">
<script type="text/javascript" src="../jquery-1.8.0.min.js"></script>
<script type="text/javascript" src="../jquery.easyui.min.js"></script>
<script>
function editNode(){
var node = $('#tt').treegrid('getSelected');
if (node){
$('#tt').treegrid('beginEdit',node.id);
}
}
function saveNode(){
var node = $('#tt').treegrid('getSelected');
if (node){
$('#tt').treegrid('endEdit',node.id);
}
}
function cancelNode(){
var node = $('#tt').treegrid('getSelected');
if (node){
$('#tt').treegrid('cancelEdit',node.id);
}
}
</script>
</head>
<body>
<h2>Editable TreeGrid - Pagination</h2>
<div class="demo-info">
<div class="demo-tip icon-tip"></div>
<div>Select node and Click edit button to perform editing.</div>
</div>
<div style="margin:10px 0">
<a href="javascript:editNode()" class="easyui-linkbutton">Edit</a>
<a href="javascript:saveNode()" class="easyui-linkbutton">Save</a>
<a href="javascript:cancelNode()" class="easyui-linkbutton">Cancel</a>
</div>
<table id="tt" title="TreeGrid" class="easyui-treegrid" style="width:700px;height:300px"
data-options="url:'treegrid_data3.json',idField:'id',treeField:'code',
rownumbers:true,pagination:true,fitColumns:true,autoRowHeight:false">
<thead>
<tr>
<th data-options="field:'code',editor:'text'" rowspan="2" width="150">Code</th>
<th colspan="2">Group Fields</th>
</tr>
<tr>
<th data-options="field:'name',editor:'text'" width="200">Name</th>
<th data-options="field:'addr',editor:'text'" width="200">Addr</th>
</tr>
</thead>
</table>
</body>
</html>
|
yyl8781697/kubcms
|
public/javascript/easyui/demo/treegrid3.html
|
HTML
|
mit
| 2,029 |
<div class="card-pf card-pf-accented card-pf-aggregate-status card-pf-aggregate-status-mini">
<h2 class="card-pf-title">
<a href="#">
<span class="fa fa-paper-plane"></span>
<span class="card-pf-aggregate-status-count">20</span> Amet
</a>
</h2>
<div class="card-pf-body">
<p class="card-pf-aggregate-status-notifications">
<span class="card-pf-aggregate-status-notification"><a href="#"><span class="pficon pficon-error-circle-o"></span>4</a></span>
</p>
</div>
</div>
|
ErnieAllen/routilities
|
www/bower_components/patternfly/tests/pages/_includes/widgets/cards/aggregate-status-amet-mini.html
|
HTML
|
apache-2.0
| 511 |
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="./../assets/css/combined.css">
<link rel="shortcut icon" href="./../favicon.ico" />
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
var path = './../';
</script>
<script src="./../assets/js/combined.js"></script>
<title>Vendor additions - PHPQuickProfiler - FuelPHP Documentation</title>
</head>
<body>
<div id="container">
<header id="header">
<div class="table">
<h1>
<strong>FuelPHP, a PHP 5.3 Framework</strong>
Documentation
</h1>
<form id="google_search">
<p>
<span id="search_clear"> </span>
<input type="submit" name="search_submit" id="search_submit" value="search" />
<input type="text" value="" id="search_input" name="search_input" />
</p>
</form>
</div>
<nav>
<div class="clear"></div>
</nav>
<a href="#" id="toc_handle">table of contents</a>
<div class="clear"></div>
</header>
<div id="cse">
<div id="cse_point"></div>
<div id="cse_content"></div>
</div>
<div id="main">
<h2>PHPQuickProfiler</h2>
<h3>Introduction</h3>
<p>
PHPQuickProfiler a small tool (think Firebug for PHP) to provide profiling and debugging related information to
developers without needing them to add a lot of programmatic overhead to their code. Now, we only need to toggle
one config setting to true and you have access to an automated tool to help create a faster and more consistent
code review experience.
</p>
<h3>Documentation</h3>
<p>You can find the original documentation <a href="http://particletree.com/features/php-quick-profiler/" target="_blank">here</a>.</p>
<h3>FuelPHP Usage</h3>
<p>
The PHPQuickProfiler vendor package is used by FuelPHP in the Profiler class, to display profiling output when the profiler is enabled.
</p>
<h3>Application Usage</h3>
<p>
You can add data to PHPQuickProfiler through the <a href="../classes/profiler.html">Profiler</a> class methods.
</p>
</div>
<footer>
<p>
© FuelPHP Development Team 2010-2015 - <a href="http://fuelphp.com">FuelPHP</a> is released under the MIT license.
</p>
</footer>
</div>
</body>
</html>
|
stabernz/wnb
|
docs/vendor/phpquickprofiler.html
|
HTML
|
mit
| 2,382 |
<!doctype html>
<title>CodeMirror: Soy (Closure Template) mode</title>
<meta charset="utf-8"/>
<link rel=stylesheet href="../../doc/docs.css">
<link rel="stylesheet" href="../../lib/codemirror.css">
<script src="../../lib/codemirror.js"></script>
<script src="../../addon/edit/matchbrackets.js"></script>
<script src="../htmlmixed/htmlmixed.js"></script>
<script src="../xml/xml.js"></script>
<script src="../javascript/javascript.js"></script>
<script src="../css/css.js"></script>
<script src="soy.js"></script>
<style>.CodeMirror {border-top: 1px solid black; border-bottom: 1px solid black;}</style>
<div id=nav>
<a href="https://codemirror.net"><h1>CodeMirror</h1><img id=logo src="../../doc/logo.png" alt=""></a>
<ul>
<li><a href="../../index.html">Home</a>
<li><a href="../../doc/manual.html">Manual</a>
<li><a href="https://github.com/codemirror/codemirror">Code</a>
</ul>
<ul>
<li><a href="../index.html">Language modes</a>
<li><a class=active href="#">Soy (Closure Template)</a>
</ul>
</div>
<article>
<h2>Soy (Closure Template) mode</h2>
<form><textarea id="code" name="code">
{namespace example}
/**
* Says hello to the world.
*/
{template .helloWorld}
{@param name: string}
{@param? score: number}
Hello <b>{$name}</b>!
<div>
{if $score}
<em>{$score} points</em>
{else}
no score
{/if}
</div>
{/template}
{template .alertHelloWorld kind="js"}
alert('Hello World');
{/template}
</textarea></form>
<script>
var editor = CodeMirror.fromTextArea(document.getElementById("code"), {
lineNumbers: true,
matchBrackets: true,
mode: "text/x-soy",
indentUnit: 2,
indentWithTabs: false
});
</script>
<p>A mode for <a href="https://developers.google.com/closure/templates/">Closure Templates</a> (Soy).</p>
<p><strong>MIME type defined:</strong> <code>text/x-soy</code>.</p>
</article>
|
bobmagicii/atlantis
|
www/share/js/codemirror-modes/soy/index.html
|
HTML
|
bsd-2-clause
| 1,931 |
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Compositing and Blending Level 1: parsing isolation with invalid values</title>
<link rel="author" title="Eric Willigers" href="mailto:[email protected]">
<link rel="help" href="https://drafts.fxtf.org/compositing-1/#propdef-isolation">
<meta name="assert" content="isolation supports only the grammar '<isolation-mode>'.">
<script src="/resources/testharness.js"></script>
<script src="/resources/testharnessreport.js"></script>
<script src="/css/support/parsing-testcommon.js"></script>
</head>
<body>
<script>
test_invalid_value("isolation", "none");
test_invalid_value("isolation", "auto isolate");
</script>
</body>
</html>
|
scheib/chromium
|
third_party/blink/web_tests/external/wpt/css/compositing/parsing/isolation-invalid.html
|
HTML
|
bsd-3-clause
| 698 |
<!DOCTYPE html>
<html>
<head>
<script src="/w3c/resources/testharness.js"></script>
<script src="/w3c/resources/testharnessreport.js"></script>
<script src="mediasource-util.js"></script>
<script src="mediasource-config-changes.js"></script>
<link rel="stylesheet" href="/w3c/resources/testharness.css">
</head>
<body>
<div id="log"></div>
<script>
mediaSourceConfigChangeTest("mp4", "av-384k-44100Hz-1ch-640x480-30fps-10kfr", "av-640k-44100Hz-1ch-640x480-30fps-10kfr", "Tests mp4 video bitrate changes in multiplexed content.");
</script>
</body>
</html>
|
js0701/chromium-crosswalk
|
third_party/WebKit/LayoutTests/http/tests/media/media-source/mediasource-config-change-mp4-av-video-bitrate.html
|
HTML
|
bsd-3-clause
| 648 |
<style>
blockquote {
color: blue;
border-left: solid blue;
padding-left: 5px;
margin: 0;
}
blockquote blockquote {
color: green;
border-left-color: green;
}
</style>
<body>
<div>
This tests that placing the cursor at the beginning of a
doubly-quoted paragraph and hitting Return splits the outer blockquote
at the right place, namely just above the inner blockquote, and inserts
an empty line there, rather than outside the outer blockquote.
</div>
<div id="div" contentEditable="true"><blockquote type="cite"><div>Lorem<br>ipsum<blockquote id="test" type="cite">dolor</blockquote></blockquote></div>
<script>
test = document.getElementById("test");
window.getSelection().collapse(test, 0);
document.execCommand("InsertNewlineInQuotedContent");
if (window.testRunner) {
window.testRunner.dumpAsText();
div = document.getElementById("div");
div.innerText = div.innerHTML;
}
</script>
</body>
|
axinging/chromium-crosswalk
|
third_party/WebKit/LayoutTests/editing/inserting/6703873-2.html
|
HTML
|
bsd-3-clause
| 1,088 |
{{+partials.standard_extensions_article article:intros.override}}
|
plxaye/chromium
|
src/chrome/common/extensions/docs/templates/public/extensions/override.html
|
HTML
|
apache-2.0
| 66 |
<!DOCTYPE html>
<html>
<!--
Copyright 2015 The Closure Library Authors. All Rights Reserved.
Use of this source code is governed by the Apache License, Version 2.0.
See the COPYING file for details.
-->
<!--
-->
<head>
<meta charset="UTF-8" />
<title>
Closure Integration Tests - goog.fs.url
</title>
<script src="../base.js">
</script>
<script>
goog.require('goog.urlTest');
</script>
</head>
<body>
</body>
</html>
|
LeoLombardi/tos-laimas-compass
|
tos-laimas-compass-win32-x64/resources/app/node_modules/closure-util/.deps/library/b06c979ecae7d78dd1ac4f7b09adec643baac308/closure/goog/fs/url_test.html
|
HTML
|
mit
| 445 |
<!DOCTYPE html>
<html>
<body>
<p>This tests typing a character after input event handler modified values of textarea. WebKit should not crash and you should see PASS below:</p>
<form><textarea oninput="this.value == 'ab' ? this.value = '' : null">a</textarea></form>
<script>
if (window.testRunner)
testRunner.dumpAsText();
var text = document.forms[0].elements[0];
text.focus();
text.setSelectionRange(text.value.length, text.value.length);
document.execCommand('InsertText', false, 'b');
document.execCommand('InsertText', false, 'c');
document.write(text.value == 'c' ? 'PASS' : 'FAIL');
</script>
</body>
</html>
|
chromium/chromium
|
third_party/blink/web_tests/editing/input/set-value-on-input-and-type-textarea.html
|
HTML
|
bsd-3-clause
| 624 |
<html>
<head>
<style>
@media screen {
@font-face {
src: local('Courier');
font-family: Courier;
}
}
</style>
<body>
<div id="console"></div>
<script>
if (window.testRunner)
testRunner.dumpAsText();
function log(message)
{
var console = document.getElementById("console");
console.appendChild(document.createTextNode(message + "\n"));
}
log("The parent sheet of a font face rule inside a media block should be defined: " + document.styleSheets[0].cssRules[0].cssRules[0].parentStyleSheet);
</script>
|
chromium/chromium
|
third_party/blink/web_tests/fast/css/nested-rule-parent-sheet.html
|
HTML
|
bsd-3-clause
| 527 |
<html>
<head>
<script>
function doTest()
{
var range = document.createRange();
range.selectNode(document.getElementById("target"));
document.getSelection().addRange(range);
}
</script>
</head>
<body onload="doTest()">
<div>
<p>
For <a href="https://bugs.webkit.org/show_bug.cgi?id=32123">Bug 32123</a>.
Hightlight for Selection should fit the target line.
</p>
<span>a</span><div id="target">should just select me</div><span>c</span>
</div>
</body>
</html>
|
scheib/chromium
|
third_party/blink/web_tests/editing/selection/range-between-block-and-inline.html
|
HTML
|
bsd-3-clause
| 483 |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Source: src/physics/p2/Body.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/default.css">
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div style="position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050"><a href="http://phaser.io"><img src="img/phaser.png" border="0" /></a></div>
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser API</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
</li>
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1">
<a href="Phaser.Animation.html">Animation</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Button.html">Button</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Angle.html">Angle</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Animation.html">Animation</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.AutoCull.html">AutoCull</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Bounds.html">Bounds</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.BringToTop.html">BringToTop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Core.html">Core</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Crop.html">Crop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Delta.html">Delta</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Destroy.html">Destroy</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.FixedToCamera.html">FixedToCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Health.html">Health</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InCamera.html">InCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InputEnabled.html">InputEnabled</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InWorld.html">InWorld</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LifeSpan.html">LifeSpan</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LoadTexture.html">LoadTexture</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Overlap.html">Overlap</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.PhysicsBody.html">PhysicsBody</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Reset.html">Reset</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.ScaleMinMax.html">ScaleMinMax</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Smoothed.html">Smoothed</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Create.html">Create</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Creature.html">Creature</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
</li>
<li class="class-depth-1">
<a href="Phaser.DeviceButton.html">DeviceButton</a>
</li>
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Events.html">Events</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Filter.html">Filter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Game.html">Game</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Group.html">Group</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ImageCollection.html">ImageCollection</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Input.html">Input</a>
</li>
<li class="class-depth-1">
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Key.html">Key</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Line.html">Line</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Loader.html">Loader</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Math.html">Math</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Matrix.html">Matrix</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Mouse.html">Mouse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Net.html">Net</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Physics.html">Physics</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.TilemapCollision.html">TilemapCollision</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Plugin.html">Plugin</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Pointer.html">Pointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RoundedRectangle.html">RoundedRectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sound.html">Sound</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="Phaser.State.html">State</a>
</li>
<li class="class-depth-1">
<a href="Phaser.StateManager.html">StateManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tile.html">Tile</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Timer.html">Timer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Touch.html">Touch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Video.html">Video</a>
</li>
<li class="class-depth-1">
<a href="Phaser.World.html">World</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BaseTexture.html">BaseTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasBuffer.html">CanvasBuffer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasGraphics.html">CanvasGraphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasMaskManager.html">CanvasMaskManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasPool.html">CanvasPool</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasRenderer.html">CanvasRenderer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasTinter.html">CanvasTinter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObject.html">DisplayObject</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Event.html">Event</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterTexture.html">FilterTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GraphicsData.html">GraphicsData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PIXI.html">PIXI</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiShader.html">PixiShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PolyK.html">PolyK</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Strip.html">Strip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.StripShader.html">StripShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Texture.html">Texture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TilingSprite.html">TilingSprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="global.html#AUTO">AUTO</a>
</li>
<li class="class-depth-0">
<a href="global.html#BITMAPDATA">BITMAPDATA</a>
</li>
<li class="class-depth-0">
<a href="global.html#BITMAPTEXT">BITMAPTEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#blendModes">blendModes</a>
</li>
<li class="class-depth-0">
<a href="global.html#BUTTON">BUTTON</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS">CANVAS</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS_FILTER">CANVAS_FILTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#CIRCLE">CIRCLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#CREATURE">CREATURE</a>
</li>
<li class="class-depth-0">
<a href="global.html#DOWN">DOWN</a>
</li>
<li class="class-depth-0">
<a href="global.html#ELLIPSE">ELLIPSE</a>
</li>
<li class="class-depth-0">
<a href="global.html#EMITTER">EMITTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#GAMES">GAMES</a>
</li>
<li class="class-depth-0">
<a href="global.html#GRAPHICS">GRAPHICS</a>
</li>
<li class="class-depth-0">
<a href="global.html#GROUP">GROUP</a>
</li>
<li class="class-depth-0">
<a href="global.html#HEADLESS">HEADLESS</a>
</li>
<li class="class-depth-0">
<a href="global.html#IMAGE">IMAGE</a>
</li>
<li class="class-depth-0">
<a href="global.html#LEFT">LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#LINE">LINE</a>
</li>
<li class="class-depth-0">
<a href="global.html#MATRIX">MATRIX</a>
</li>
<li class="class-depth-0">
<a href="global.html#NONE">NONE</a>
</li>
<li class="class-depth-0">
<a href="global.html#POINT">POINT</a>
</li>
<li class="class-depth-0">
<a href="global.html#POINTER">POINTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#POLYGON">POLYGON</a>
</li>
<li class="class-depth-0">
<a href="global.html#RECTANGLE">RECTANGLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#RENDERTEXTURE">RENDERTEXTURE</a>
</li>
<li class="class-depth-0">
<a href="global.html#RETROFONT">RETROFONT</a>
</li>
<li class="class-depth-0">
<a href="global.html#RIGHT">RIGHT</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROPE">ROPE</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROUNDEDRECTANGLE">ROUNDEDRECTANGLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#scaleModes">scaleModes</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITE">SPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITEBATCH">SPRITEBATCH</a>
</li>
<li class="class-depth-0">
<a href="global.html#TEXT">TEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAP">TILEMAP</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAPLAYER">TILEMAPLAYER</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILESPRITE">TILESPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#UP">UP</a>
</li>
<li class="class-depth-0">
<a href="global.html#VERSION">VERSION</a>
</li>
<li class="class-depth-0">
<a href="global.html#VIDEO">VIDEO</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL">WEBGL</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL_FILTER">WEBGL_FILTER</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li>
<li class="class-depth-1"><a href="Phaser.Group.html">Group</a></li>
<li class="class-depth-1"><a href="Phaser.World.html">World</a></li>
<li class="class-depth-1"><a href="Phaser.Loader.html">Loader</a></li>
<li class="class-depth-1"><a href="Phaser.Cache.html">Cache</a></li>
<li class="class-depth-1"><a href="Phaser.Time.html">Time</a></li>
<li class="class-depth-1"><a href="Phaser.Camera.html">Camera</a></li>
<li class="class-depth-1"><a href="Phaser.StateManager.html">State Manager</a></li>
<li class="class-depth-1"><a href="Phaser.TweenManager.html">Tween Manager</a></li>
<li class="class-depth-1"><a href="Phaser.SoundManager.html">Sound Manager</a></li>
<li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li>
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.GameObjectFactory.html">Factory (game.add)</a></li>
<li class="class-depth-1"><a href="Phaser.GameObjectCreator.html">Creator (game.make)</a></li>
<li class="class-depth-1"><a href="Phaser.Sprite.html">Sprite</a></li>
<li class="class-depth-1"><a href="Phaser.Image.html">Image</a></li>
<li class="class-depth-1"><a href="Phaser.Sound.html">Sound</a></li>
<li class="class-depth-1"><a href="Phaser.Video.html">Video</a></li>
<li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li>
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
<li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li>
<li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li>
<li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li>
<li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li>
<li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li>
<li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li>
<li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li>
<li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li>
<li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Geometry<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Circle.html">Circle</a></li>
<li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li>
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Matrix.html">Matrix</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
<li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.RoundedRectangle.html">Rounded Rectangle</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Input<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.InputHandler.html">Input Handler</a></li>
<li class="class-depth-1"><a href="Phaser.Pointer.html">Pointer</a></li>
<li class="class-depth-1"><a href="Phaser.DeviceButton.html">Device Button</a></li>
<li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li>
<li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li>
<li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li>
<li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="http://phaser.io">Phaser Web Site</a></li>
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
<li class="class-depth-1"><a href="http://phaser.io/examples">Phaser Examples</a></li>
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser-plugins">Phaser Plugins</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a></li>
<li class="class-depth-1"><a href="http://stackoverflow.com/questions/tagged/phaser-framework">Stack Overflow</a></li>
<li class="class-depth-1"><a href="http://phaser.io/learn">Tutorials</a></li>
<li class="class-depth-1"><a href="https://confirmsubscription.com/h/r/369DE48E3E86AF1E">Newsletter</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/twitter">Twitter</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/irc">IRC</a></li>
<li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
<h1 class="page-title">Source: src/physics/p2/Body.js</h1>
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/**
* @author Richard Davey <[email protected]>
* @copyright 2015 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* The Physics Body is typically linked to a single Sprite and defines properties that determine how the physics body is simulated.
* These properties affect how the body reacts to forces, what forces it generates on itself (to simulate friction), and how it reacts to collisions in the scene.
* In most cases, the properties are used to simulate physical effects. Each body also has its own property values that determine exactly how it reacts to forces and collisions in the scene.
* By default a single Rectangle shape is added to the Body that matches the dimensions of the parent Sprite. See addShape, removeShape, clearShapes to add extra shapes around the Body.
* Note: When bound to a Sprite to avoid single-pixel jitters on mobile devices we strongly recommend using Sprite sizes that are even on both axis, i.e. 128x128 not 127x127.
* Note: When a game object is given a P2 body it has its anchor x/y set to 0.5, so it becomes centered.
*
* @class Phaser.Physics.P2.Body
* @constructor
* @param {Phaser.Game} game - Game reference to the currently running game.
* @param {Phaser.Sprite} [sprite] - The Sprite object this physics body belongs to.
* @param {number} [x=0] - The x coordinate of this Body.
* @param {number} [y=0] - The y coordinate of this Body.
* @param {number} [mass=1] - The default mass of this Body (0 = static).
*/
Phaser.Physics.P2.Body = function (game, sprite, x, y, mass) {
sprite = sprite || null;
x = x || 0;
y = y || 0;
if (mass === undefined) { mass = 1; }
/**
* @property {Phaser.Game} game - Local reference to game.
*/
this.game = game;
/**
* @property {Phaser.Physics.P2} world - Local reference to the P2 World.
*/
this.world = game.physics.p2;
/**
* @property {Phaser.Sprite} sprite - Reference to the parent Sprite.
*/
this.sprite = sprite;
/**
* @property {number} type - The type of physics system this body belongs to.
*/
this.type = Phaser.Physics.P2JS;
/**
* @property {Phaser.Point} offset - The offset of the Physics Body from the Sprite x/y position.
*/
this.offset = new Phaser.Point();
/**
* @property {p2.Body} data - The p2 Body data.
* @protected
*/
this.data = new p2.Body({ position: [ this.world.pxmi(x), this.world.pxmi(y) ], mass: mass });
this.data.parent = this;
/**
* @property {Phaser.Physics.P2.InversePointProxy} velocity - The velocity of the body. Set velocity.x to a negative value to move to the left, position to the right. velocity.y negative values move up, positive move down.
*/
this.velocity = new Phaser.Physics.P2.InversePointProxy(this.world, this.data.velocity);
/**
* @property {Phaser.Physics.P2.InversePointProxy} force - The force applied to the body.
*/
this.force = new Phaser.Physics.P2.InversePointProxy(this.world, this.data.force);
/**
* @property {Phaser.Point} gravity - A locally applied gravity force to the Body. Applied directly before the world step. NOTE: Not currently implemented.
*/
this.gravity = new Phaser.Point();
/**
* Dispatched when a first contact is created between shapes in two bodies.
* This event is fired during the step, so collision has already taken place.
*
* The event will be sent 5 arguments in this order:
*
* The Phaser.Physics.P2.Body it is in contact with. *This might be null* if the Body was created directly in the p2 world.
* The p2.Body this Body is in contact with.
* The Shape from this body that caused the contact.
* The Shape from the contact body.
* The Contact Equation data array.
*
* @property {Phaser.Signal} onBeginContact
*/
this.onBeginContact = new Phaser.Signal();
/**
* Dispatched when contact ends between shapes in two bodies.
* This event is fired during the step, so collision has already taken place.
*
* The event will be sent 4 arguments in this order:
*
* The Phaser.Physics.P2.Body it is in contact with. *This might be null* if the Body was created directly in the p2 world.
* The p2.Body this Body has ended contact with.
* The Shape from this body that caused the original contact.
* The Shape from the contact body.
*
* @property {Phaser.Signal} onEndContact
*/
this.onEndContact = new Phaser.Signal();
/**
* @property {array} collidesWith - Array of CollisionGroups that this Bodies shapes collide with.
*/
this.collidesWith = [];
/**
* @property {boolean} removeNextStep - To avoid deleting this body during a physics step, and causing all kinds of problems, set removeNextStep to true to have it removed in the next preUpdate.
*/
this.removeNextStep = false;
/**
* @property {Phaser.Physics.P2.BodyDebug} debugBody - Reference to the debug body.
*/
this.debugBody = null;
/**
* @property {boolean} dirty - Internally used by Sprite.x/y
*/
this.dirty = false;
/**
* @property {boolean} _collideWorldBounds - Internal var that determines if this Body collides with the world bounds or not.
* @private
*/
this._collideWorldBounds = true;
/**
* @property {object} _bodyCallbacks - Array of Body callbacks.
* @private
*/
this._bodyCallbacks = {};
/**
* @property {object} _bodyCallbackContext - Array of Body callback contexts.
* @private
*/
this._bodyCallbackContext = {};
/**
* @property {object} _groupCallbacks - Array of Group callbacks.
* @private
*/
this._groupCallbacks = {};
/**
* @property {object} _bodyCallbackContext - Array of Grouo callback contexts.
* @private
*/
this._groupCallbackContext = {};
/**
* @property {boolean} _reset - Internal var.
* @private
*/
this._reset = false;
// Set-up the default shape
if (sprite)
{
this.setRectangleFromSprite(sprite);
if (sprite.exists)
{
this.game.physics.p2.addBody(this);
}
}
};
Phaser.Physics.P2.Body.prototype = {
/**
* Sets a callback to be fired any time a shape in this Body impacts with a shape in the given Body. The impact test is performed against body.id values.
* The callback will be sent 4 parameters: This body, the body that impacted, the Shape in this body and the shape in the impacting body.
* Note that the impact event happens after collision resolution, so it cannot be used to prevent a collision from happening.
* It also happens mid-step. So do not destroy a Body during this callback, instead set safeDestroy to true so it will be killed on the next preUpdate.
*
* @method Phaser.Physics.P2.Body#createBodyCallback
* @param {Phaser.Sprite|Phaser.TileSprite|Phaser.Physics.P2.Body|p2.Body} object - The object to send impact events for.
* @param {function} callback - The callback to fire on impact. Set to null to clear a previously set callback.
* @param {object} callbackContext - The context under which the callback will fire.
*/
createBodyCallback: function (object, callback, callbackContext) {
var id = -1;
if (object['id'])
{
id = object.id;
}
else if (object['body'])
{
id = object.body.id;
}
if (id > -1)
{
if (callback === null)
{
delete (this._bodyCallbacks[id]);
delete (this._bodyCallbackContext[id]);
}
else
{
this._bodyCallbacks[id] = callback;
this._bodyCallbackContext[id] = callbackContext;
}
}
},
/**
* Sets a callback to be fired any time this Body impacts with the given Group. The impact test is performed against shape.collisionGroup values.
* The callback will be sent 4 parameters: This body, the body that impacted, the Shape in this body and the shape in the impacting body.
* This callback will only fire if this Body has been assigned a collision group.
* Note that the impact event happens after collision resolution, so it cannot be used to prevent a collision from happening.
* It also happens mid-step. So do not destroy a Body during this callback, instead set safeDestroy to true so it will be killed on the next preUpdate.
*
* @method Phaser.Physics.P2.Body#createGroupCallback
* @param {Phaser.Physics.CollisionGroup} group - The Group to send impact events for.
* @param {function} callback - The callback to fire on impact. Set to null to clear a previously set callback.
* @param {object} callbackContext - The context under which the callback will fire.
*/
createGroupCallback: function (group, callback, callbackContext) {
if (callback === null)
{
delete (this._groupCallbacks[group.mask]);
delete (this._groupCallbackContext[group.mask]);
}
else
{
this._groupCallbacks[group.mask] = callback;
this._groupCallbackContext[group.mask] = callbackContext;
}
},
/**
* Gets the collision bitmask from the groups this body collides with.
*
* @method Phaser.Physics.P2.Body#getCollisionMask
* @return {number} The bitmask.
*/
getCollisionMask: function () {
var mask = 0;
if (this._collideWorldBounds)
{
mask = this.game.physics.p2.boundsCollisionGroup.mask;
}
for (var i = 0; i < this.collidesWith.length; i++)
{
mask = mask | this.collidesWith[i].mask;
}
return mask;
},
/**
* Updates the collisionMask.
*
* @method Phaser.Physics.P2.Body#updateCollisionMask
* @param {p2.Shape} [shape] - An optional Shape. If not provided the collision group will be added to all Shapes in this Body.
*/
updateCollisionMask: function (shape) {
var mask = this.getCollisionMask();
if (shape === undefined)
{
for (var i = this.data.shapes.length - 1; i >= 0; i--)
{
this.data.shapes[i].collisionMask = mask;
}
}
else
{
shape.collisionMask = mask;
}
},
/**
* Sets the given CollisionGroup to be the collision group for all shapes in this Body, unless a shape is specified.
* This also resets the collisionMask.
*
* @method Phaser.Physics.P2.Body#setCollisionGroup
* @param {Phaser.Physics.CollisionGroup} group - The Collision Group that this Bodies shapes will use.
* @param {p2.Shape} [shape] - An optional Shape. If not provided the collision group will be added to all Shapes in this Body.
*/
setCollisionGroup: function (group, shape) {
var mask = this.getCollisionMask();
if (shape === undefined)
{
for (var i = this.data.shapes.length - 1; i >= 0; i--)
{
this.data.shapes[i].collisionGroup = group.mask;
this.data.shapes[i].collisionMask = mask;
}
}
else
{
shape.collisionGroup = group.mask;
shape.collisionMask = mask;
}
},
/**
* Clears the collision data from the shapes in this Body. Optionally clears Group and/or Mask.
*
* @method Phaser.Physics.P2.Body#clearCollision
* @param {boolean} [clearGroup=true] - Clear the collisionGroup value from the shape/s?
* @param {boolean} [clearMask=true] - Clear the collisionMask value from the shape/s?
* @param {p2.Shape} [shape] - An optional Shape. If not provided the collision data will be cleared from all Shapes in this Body.
*/
clearCollision: function (clearGroup, clearMask, shape) {
if (clearGroup === undefined) { clearGroup = true; }
if (clearMask === undefined) { clearMask = true; }
if (shape === undefined)
{
for (var i = this.data.shapes.length - 1; i >= 0; i--)
{
if (clearGroup)
{
this.data.shapes[i].collisionGroup = null;
}
if (clearMask)
{
this.data.shapes[i].collisionMask = null;
}
}
}
else
{
if (clearGroup)
{
shape.collisionGroup = null;
}
if (clearMask)
{
shape.collisionMask = null;
}
}
if (clearGroup)
{
this.collidesWith.length = 0;
}
},
/**
* Adds the given CollisionGroup, or array of CollisionGroups, to the list of groups that this body will collide with and updates the collision masks.
*
* @method Phaser.Physics.P2.Body#collides
* @param {Phaser.Physics.CollisionGroup|array} group - The Collision Group or Array of Collision Groups that this Bodies shapes will collide with.
* @param {function} [callback] - Optional callback that will be triggered when this Body impacts with the given Group.
* @param {object} [callbackContext] - The context under which the callback will be called.
* @param {p2.Shape} [shape] - An optional Shape. If not provided the collision mask will be added to all Shapes in this Body.
*/
collides: function (group, callback, callbackContext, shape) {
if (Array.isArray(group))
{
for (var i = 0; i < group.length; i++)
{
if (this.collidesWith.indexOf(group[i]) === -1)
{
this.collidesWith.push(group[i]);
if (callback)
{
this.createGroupCallback(group[i], callback, callbackContext);
}
}
}
}
else
{
if (this.collidesWith.indexOf(group) === -1)
{
this.collidesWith.push(group);
if (callback)
{
this.createGroupCallback(group, callback, callbackContext);
}
}
}
var mask = this.getCollisionMask();
if (shape === undefined)
{
for (var i = this.data.shapes.length - 1; i >= 0; i--)
{
this.data.shapes[i].collisionMask = mask;
}
}
else
{
shape.collisionMask = mask;
}
},
/**
* Moves the shape offsets so their center of mass becomes the body center of mass.
*
* @method Phaser.Physics.P2.Body#adjustCenterOfMass
*/
adjustCenterOfMass: function () {
this.data.adjustCenterOfMass();
this.shapeChanged();
},
/**
* Gets the velocity of a point in the body.
*
* @method Phaser.Physics.P2.Body#getVelocityAtPoint
* @param {Array} result - A vector to store the result in.
* @param {Array} relativePoint - A world oriented vector, indicating the position of the point to get the velocity from.
* @return {Array} The result vector.
*/
getVelocityAtPoint: function (result, relativePoint) {
return this.data.getVelocityAtPoint(result, relativePoint);
},
/**
* Apply damping, see http://code.google.com/p/bullet/issues/detail?id=74 for details.
*
* @method Phaser.Physics.P2.Body#applyDamping
* @param {number} dt - Current time step.
*/
applyDamping: function (dt) {
this.data.applyDamping(dt);
},
/**
* Apply impulse to a point relative to the body.
* This could for example be a point on the Body surface. An impulse is a force added to a body during a short
* period of time (impulse = force * time). Impulses will be added to Body.velocity and Body.angularVelocity.
*
* @method Phaser.Physics.P2.Body#applyImpulse
* @param {Float32Array|Array} impulse - The impulse vector to add, oriented in world space.
* @param {number} worldX - A point relative to the body in world space. If not given, it is set to zero and all of the impulse will be exerted on the center of mass.
* @param {number} worldY - A point relative to the body in world space. If not given, it is set to zero and all of the impulse will be exerted on the center of mass.
*/
applyImpulse: function (impulse, worldX, worldY) {
this.data.applyImpulse(impulse, [this.world.pxmi(worldX), this.world.pxmi(worldY)]);
},
/**
* Apply impulse to a point local to the body.
*
* This could for example be a point on the Body surface. An impulse is a force added to a body during a short
* period of time (impulse = force * time). Impulses will be added to Body.velocity and Body.angularVelocity.
*
* @method Phaser.Physics.P2.Body#applyImpulseLocal
* @param {Float32Array|Array} impulse - The impulse vector to add, oriented in world space.
* @param {number} localX - A local point on the body.
* @param {number} localY - A local point on the body.
*/
applyImpulseLocal: function (impulse, localX, localY) {
this.data.applyImpulseLocal(impulse, [this.world.pxmi(localX), this.world.pxmi(localY)]);
},
/**
* Apply force to a world point.
*
* This could for example be a point on the RigidBody surface. Applying force
* this way will add to Body.force and Body.angularForce.
*
* @method Phaser.Physics.P2.Body#applyForce
* @param {Float32Array|Array} force - The force vector to add.
* @param {number} worldX - The world x point to apply the force on.
* @param {number} worldY - The world y point to apply the force on.
*/
applyForce: function (force, worldX, worldY) {
this.data.applyForce(force, [this.world.pxmi(worldX), this.world.pxmi(worldY)]);
},
/**
* Sets the force on the body to zero.
*
* @method Phaser.Physics.P2.Body#setZeroForce
*/
setZeroForce: function () {
this.data.setZeroForce();
},
/**
* If this Body is dynamic then this will zero its angular velocity.
*
* @method Phaser.Physics.P2.Body#setZeroRotation
*/
setZeroRotation: function () {
this.data.angularVelocity = 0;
},
/**
* If this Body is dynamic then this will zero its velocity on both axis.
*
* @method Phaser.Physics.P2.Body#setZeroVelocity
*/
setZeroVelocity: function () {
this.data.velocity[0] = 0;
this.data.velocity[1] = 0;
},
/**
* Sets the Body damping and angularDamping to zero.
*
* @method Phaser.Physics.P2.Body#setZeroDamping
*/
setZeroDamping: function () {
this.data.damping = 0;
this.data.angularDamping = 0;
},
/**
* Transform a world point to local body frame.
*
* @method Phaser.Physics.P2.Body#toLocalFrame
* @param {Float32Array|Array} out - The vector to store the result in.
* @param {Float32Array|Array} worldPoint - The input world vector.
*/
toLocalFrame: function (out, worldPoint) {
return this.data.toLocalFrame(out, worldPoint);
},
/**
* Transform a local point to world frame.
*
* @method Phaser.Physics.P2.Body#toWorldFrame
* @param {Array} out - The vector to store the result in.
* @param {Array} localPoint - The input local vector.
*/
toWorldFrame: function (out, localPoint) {
return this.data.toWorldFrame(out, localPoint);
},
/**
* This will rotate the Body by the given speed to the left (counter-clockwise).
*
* @method Phaser.Physics.P2.Body#rotateLeft
* @param {number} speed - The speed at which it should rotate.
*/
rotateLeft: function (speed) {
this.data.angularVelocity = this.world.pxm(-speed);
},
/**
* This will rotate the Body by the given speed to the left (clockwise).
*
* @method Phaser.Physics.P2.Body#rotateRight
* @param {number} speed - The speed at which it should rotate.
*/
rotateRight: function (speed) {
this.data.angularVelocity = this.world.pxm(speed);
},
/**
* Moves the Body forwards based on its current angle and the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
* @method Phaser.Physics.P2.Body#moveForward
* @param {number} speed - The speed at which it should move forwards.
*/
moveForward: function (speed) {
var magnitude = this.world.pxmi(-speed);
var angle = this.data.angle + Math.PI / 2;
this.data.velocity[0] = magnitude * Math.cos(angle);
this.data.velocity[1] = magnitude * Math.sin(angle);
},
/**
* Moves the Body backwards based on its current angle and the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
* @method Phaser.Physics.P2.Body#moveBackward
* @param {number} speed - The speed at which it should move backwards.
*/
moveBackward: function (speed) {
var magnitude = this.world.pxmi(-speed);
var angle = this.data.angle + Math.PI / 2;
this.data.velocity[0] = -(magnitude * Math.cos(angle));
this.data.velocity[1] = -(magnitude * Math.sin(angle));
},
/**
* Applies a force to the Body that causes it to 'thrust' forwards, based on its current angle and the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
* @method Phaser.Physics.P2.Body#thrust
* @param {number} speed - The speed at which it should thrust.
*/
thrust: function (speed) {
var magnitude = this.world.pxmi(-speed);
var angle = this.data.angle + Math.PI / 2;
this.data.force[0] += magnitude * Math.cos(angle);
this.data.force[1] += magnitude * Math.sin(angle);
},
/**
* Applies a force to the Body that causes it to 'thrust' backwards (in reverse), based on its current angle and the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
* @method Phaser.Physics.P2.Body#reverse
* @param {number} speed - The speed at which it should reverse.
*/
reverse: function (speed) {
var magnitude = this.world.pxmi(-speed);
var angle = this.data.angle + Math.PI / 2;
this.data.force[0] -= magnitude * Math.cos(angle);
this.data.force[1] -= magnitude * Math.sin(angle);
},
/**
* If this Body is dynamic then this will move it to the left by setting its x velocity to the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
* @method Phaser.Physics.P2.Body#moveLeft
* @param {number} speed - The speed at which it should move to the left, in pixels per second.
*/
moveLeft: function (speed) {
this.data.velocity[0] = this.world.pxmi(-speed);
},
/**
* If this Body is dynamic then this will move it to the right by setting its x velocity to the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
* @method Phaser.Physics.P2.Body#moveRight
* @param {number} speed - The speed at which it should move to the right, in pixels per second.
*/
moveRight: function (speed) {
this.data.velocity[0] = this.world.pxmi(speed);
},
/**
* If this Body is dynamic then this will move it up by setting its y velocity to the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
* @method Phaser.Physics.P2.Body#moveUp
* @param {number} speed - The speed at which it should move up, in pixels per second.
*/
moveUp: function (speed) {
this.data.velocity[1] = this.world.pxmi(-speed);
},
/**
* If this Body is dynamic then this will move it down by setting its y velocity to the given speed.
* The speed is represented in pixels per second. So a value of 100 would move 100 pixels in 1 second (1000ms).
*
* @method Phaser.Physics.P2.Body#moveDown
* @param {number} speed - The speed at which it should move down, in pixels per second.
*/
moveDown: function (speed) {
this.data.velocity[1] = this.world.pxmi(speed);
},
/**
* Internal method. This is called directly before the sprites are sent to the renderer and after the update function has finished.
*
* @method Phaser.Physics.P2.Body#preUpdate
* @protected
*/
preUpdate: function () {
this.dirty = true;
if (this.removeNextStep)
{
this.removeFromWorld();
this.removeNextStep = false;
}
},
/**
* Internal method. This is called directly before the sprites are sent to the renderer and after the update function has finished.
*
* @method Phaser.Physics.P2.Body#postUpdate
* @protected
*/
postUpdate: function () {
this.sprite.x = this.world.mpxi(this.data.position[0]);
this.sprite.y = this.world.mpxi(this.data.position[1]);
if (!this.fixedRotation)
{
this.sprite.rotation = this.data.angle;
}
if (this.debugBody)
{
this.debugBody.updateSpriteTransform();
}
this.dirty = false;
},
/**
* Resets the Body force, velocity (linear and angular) and rotation. Optionally resets damping and mass.
*
* @method Phaser.Physics.P2.Body#reset
* @param {number} x - The new x position of the Body.
* @param {number} y - The new x position of the Body.
* @param {boolean} [resetDamping=false] - Resets the linear and angular damping.
* @param {boolean} [resetMass=false] - Sets the Body mass back to 1.
*/
reset: function (x, y, resetDamping, resetMass) {
if (resetDamping === undefined) { resetDamping = false; }
if (resetMass === undefined) { resetMass = false; }
this.setZeroForce();
this.setZeroVelocity();
this.setZeroRotation();
if (resetDamping)
{
this.setZeroDamping();
}
if (resetMass)
{
this.mass = 1;
}
this.x = x;
this.y = y;
},
/**
* Adds this physics body to the world.
*
* @method Phaser.Physics.P2.Body#addToWorld
*/
addToWorld: function () {
if (this.game.physics.p2._toRemove)
{
for (var i = 0; i < this.game.physics.p2._toRemove.length; i++)
{
if (this.game.physics.p2._toRemove[i] === this)
{
this.game.physics.p2._toRemove.splice(i, 1);
}
}
}
if (this.data.world !== this.game.physics.p2.world)
{
this.game.physics.p2.addBody(this);
}
},
/**
* Removes this physics body from the world.
*
* @method Phaser.Physics.P2.Body#removeFromWorld
*/
removeFromWorld: function () {
if (this.data.world === this.game.physics.p2.world)
{
this.game.physics.p2.removeBodyNextStep(this);
}
},
/**
* Destroys this Body and all references it holds to other objects.
*
* @method Phaser.Physics.P2.Body#destroy
*/
destroy: function () {
this.removeFromWorld();
this.clearShapes();
this._bodyCallbacks = {};
this._bodyCallbackContext = {};
this._groupCallbacks = {};
this._groupCallbackContext = {};
if (this.debugBody)
{
this.debugBody.destroy(true, true);
}
this.debugBody = null;
if (this.sprite)
{
this.sprite.body = null;
this.sprite = null;
}
},
/**
* Removes all Shapes from this Body.
*
* @method Phaser.Physics.P2.Body#clearShapes
*/
clearShapes: function () {
var i = this.data.shapes.length;
while (i--)
{
this.data.removeShape(this.data.shapes[i]);
}
this.shapeChanged();
},
/**
* Add a shape to the body. You can pass a local transform when adding a shape, so that the shape gets an offset and an angle relative to the body center of mass.
* Will automatically update the mass properties and bounding radius.
* If this Body had a previously set Collision Group you will need to re-apply it to the new Shape this creates.
*
* @method Phaser.Physics.P2.Body#addShape
* @param {p2.Shape} shape - The shape to add to the body.
* @param {number} [offsetX=0] - Local horizontal offset of the shape relative to the body center of mass.
* @param {number} [offsetY=0] - Local vertical offset of the shape relative to the body center of mass.
* @param {number} [rotation=0] - Local rotation of the shape relative to the body center of mass, specified in radians.
* @return {p2.Shape} The shape that was added to the body.
*/
addShape: function (shape, offsetX, offsetY, rotation) {
if (offsetX === undefined) { offsetX = 0; }
if (offsetY === undefined) { offsetY = 0; }
if (rotation === undefined) { rotation = 0; }
this.data.addShape(shape, [this.world.pxmi(offsetX), this.world.pxmi(offsetY)], rotation);
this.shapeChanged();
return shape;
},
/**
* Adds a Circle shape to this Body. You can control the offset from the center of the body and the rotation.
*
* @method Phaser.Physics.P2.Body#addCircle
* @param {number} radius - The radius of this circle (in pixels)
* @param {number} [offsetX=0] - Local horizontal offset of the shape relative to the body center of mass.
* @param {number} [offsetY=0] - Local vertical offset of the shape relative to the body center of mass.
* @param {number} [rotation=0] - Local rotation of the shape relative to the body center of mass, specified in radians.
* @return {p2.Circle} The Circle shape that was added to the Body.
*/
addCircle: function (radius, offsetX, offsetY, rotation) {
var shape = new p2.Circle({ radius: this.world.pxm(radius) });
return this.addShape(shape, offsetX, offsetY, rotation);
},
/**
* Adds a Rectangle shape to this Body. You can control the offset from the center of the body and the rotation.
*
* @method Phaser.Physics.P2.Body#addRectangle
* @param {number} width - The width of the rectangle in pixels.
* @param {number} height - The height of the rectangle in pixels.
* @param {number} [offsetX=0] - Local horizontal offset of the shape relative to the body center of mass.
* @param {number} [offsetY=0] - Local vertical offset of the shape relative to the body center of mass.
* @param {number} [rotation=0] - Local rotation of the shape relative to the body center of mass, specified in radians.
* @return {p2.Box} The shape that was added to the Body.
*/
addRectangle: function (width, height, offsetX, offsetY, rotation) {
var shape = new p2.Box({ width: this.world.pxm(width), height: this.world.pxm(height)});
return this.addShape(shape, offsetX, offsetY, rotation);
},
/**
* Adds a Plane shape to this Body. The plane is facing in the Y direction. You can control the offset from the center of the body and the rotation.
*
* @method Phaser.Physics.P2.Body#addPlane
* @param {number} [offsetX=0] - Local horizontal offset of the shape relative to the body center of mass.
* @param {number} [offsetY=0] - Local vertical offset of the shape relative to the body center of mass.
* @param {number} [rotation=0] - Local rotation of the shape relative to the body center of mass, specified in radians.
* @return {p2.Plane} The Plane shape that was added to the Body.
*/
addPlane: function (offsetX, offsetY, rotation) {
var shape = new p2.Plane();
return this.addShape(shape, offsetX, offsetY, rotation);
},
/**
* Adds a Particle shape to this Body. You can control the offset from the center of the body and the rotation.
*
* @method Phaser.Physics.P2.Body#addParticle
* @param {number} [offsetX=0] - Local horizontal offset of the shape relative to the body center of mass.
* @param {number} [offsetY=0] - Local vertical offset of the shape relative to the body center of mass.
* @param {number} [rotation=0] - Local rotation of the shape relative to the body center of mass, specified in radians.
* @return {p2.Particle} The Particle shape that was added to the Body.
*/
addParticle: function (offsetX, offsetY, rotation) {
var shape = new p2.Particle();
return this.addShape(shape, offsetX, offsetY, rotation);
},
/**
* Adds a Line shape to this Body.
* The line shape is along the x direction, and stretches from [-length/2, 0] to [length/2,0].
* You can control the offset from the center of the body and the rotation.
*
* @method Phaser.Physics.P2.Body#addLine
* @param {number} length - The length of this line (in pixels)
* @param {number} [offsetX=0] - Local horizontal offset of the shape relative to the body center of mass.
* @param {number} [offsetY=0] - Local vertical offset of the shape relative to the body center of mass.
* @param {number} [rotation=0] - Local rotation of the shape relative to the body center of mass, specified in radians.
* @return {p2.Line} The Line shape that was added to the Body.
*/
addLine: function (length, offsetX, offsetY, rotation) {
var shape = new p2.Line({ length: this.world.pxm(length)});
return this.addShape(shape, offsetX, offsetY, rotation);
},
/**
* Adds a Capsule shape to this Body.
* You can control the offset from the center of the body and the rotation.
*
* @method Phaser.Physics.P2.Body#addCapsule
* @param {number} length - The distance between the end points in pixels.
* @param {number} radius - Radius of the capsule in pixels.
* @param {number} [offsetX=0] - Local horizontal offset of the shape relative to the body center of mass.
* @param {number} [offsetY=0] - Local vertical offset of the shape relative to the body center of mass.
* @param {number} [rotation=0] - Local rotation of the shape relative to the body center of mass, specified in radians.
* @return {p2.Capsule} The Capsule shape that was added to the Body.
*/
addCapsule: function (length, radius, offsetX, offsetY, rotation) {
var shape = new p2.Capsule({ length: this.world.pxm(length), radius: this.world.pxm(radius) });
return this.addShape(shape, offsetX, offsetY, rotation);
},
/**
* Reads a polygon shape path, and assembles convex shapes from that and puts them at proper offset points. The shape must be simple and without holes.
* This function expects the x.y values to be given in pixels. If you want to provide them at p2 world scales then call Body.data.fromPolygon directly.
*
* @method Phaser.Physics.P2.Body#addPolygon
* @param {object} options - An object containing the build options:
* @param {boolean} [options.optimalDecomp=false] - Set to true if you need optimal decomposition. Warning: very slow for polygons with more than 10 vertices.
* @param {boolean} [options.skipSimpleCheck=false] - Set to true if you already know that the path is not intersecting itself.
* @param {boolean|number} [options.removeCollinearPoints=false] - Set to a number (angle threshold value) to remove collinear points, or false to keep all points.
* @param {(number[]|...number)} points - An array of 2d vectors that form the convex or concave polygon.
* Either [[0,0], [0,1],...] or a flat array of numbers that will be interpreted as [x,y, x,y, ...],
* or the arguments passed can be flat x,y values e.g. `setPolygon(options, x,y, x,y, x,y, ...)` where `x` and `y` are numbers.
* @return {boolean} True on success, else false.
*/
addPolygon: function (options, points) {
options = options || {};
if (!Array.isArray(points))
{
points = Array.prototype.slice.call(arguments, 1);
}
var path = [];
// Did they pass in a single array of points?
if (points.length === 1 && Array.isArray(points[0]))
{
path = points[0].slice(0);
}
else if (Array.isArray(points[0]))
{
path = points.slice();
}
else if (typeof points[0] === 'number')
{
// We've a list of numbers
for (var i = 0, len = points.length; i < len; i += 2)
{
path.push([points[i], points[i + 1]]);
}
}
// top and tail
var idx = path.length - 1;
if (path[idx][0] === path[0][0] && path[idx][1] === path[0][1])
{
path.pop();
}
// Now process them into p2 values
for (var p = 0; p < path.length; p++)
{
path[p][0] = this.world.pxmi(path[p][0]);
path[p][1] = this.world.pxmi(path[p][1]);
}
var result = this.data.fromPolygon(path, options);
this.shapeChanged();
return result;
},
/**
* Remove a shape from the body. Will automatically update the mass properties and bounding radius.
*
* @method Phaser.Physics.P2.Body#removeShape
* @param {p2.Circle|p2.Rectangle|p2.Plane|p2.Line|p2.Particle} shape - The shape to remove from the body.
* @return {boolean} True if the shape was found and removed, else false.
*/
removeShape: function (shape) {
var result = this.data.removeShape(shape);
this.shapeChanged();
return result;
},
/**
* Clears any previously set shapes. Then creates a new Circle shape and adds it to this Body.
* If this Body had a previously set Collision Group you will need to re-apply it to the new Shape this creates.
*
* @method Phaser.Physics.P2.Body#setCircle
* @param {number} radius - The radius of this circle (in pixels)
* @param {number} [offsetX=0] - Local horizontal offset of the shape relative to the body center of mass.
* @param {number} [offsetY=0] - Local vertical offset of the shape relative to the body center of mass.
* @param {number} [rotation=0] - Local rotation of the shape relative to the body center of mass, specified in radians.
*/
setCircle: function (radius, offsetX, offsetY, rotation) {
this.clearShapes();
return this.addCircle(radius, offsetX, offsetY, rotation);
},
/**
* Clears any previously set shapes. The creates a new Rectangle shape at the given size and offset, and adds it to this Body.
* If you wish to create a Rectangle to match the size of a Sprite or Image see Body.setRectangleFromSprite.
* If this Body had a previously set Collision Group you will need to re-apply it to the new Shape this creates.
*
* @method Phaser.Physics.P2.Body#setRectangle
* @param {number} [width=16] - The width of the rectangle in pixels.
* @param {number} [height=16] - The height of the rectangle in pixels.
* @param {number} [offsetX=0] - Local horizontal offset of the shape relative to the body center of mass.
* @param {number} [offsetY=0] - Local vertical offset of the shape relative to the body center of mass.
* @param {number} [rotation=0] - Local rotation of the shape relative to the body center of mass, specified in radians.
* @return {p2.Rectangle} The Rectangle shape that was added to the Body.
*/
setRectangle: function (width, height, offsetX, offsetY, rotation) {
if (width === undefined) { width = 16; }
if (height === undefined) { height = 16; }
this.clearShapes();
return this.addRectangle(width, height, offsetX, offsetY, rotation);
},
/**
* Clears any previously set shapes.
* Then creates a Rectangle shape sized to match the dimensions and orientation of the Sprite given.
* If no Sprite is given it defaults to using the parent of this Body.
* If this Body had a previously set Collision Group you will need to re-apply it to the new Shape this creates.
*
* @method Phaser.Physics.P2.Body#setRectangleFromSprite
* @param {Phaser.Sprite|Phaser.Image} [sprite] - The Sprite on which the Rectangle will get its dimensions.
* @return {p2.Rectangle} The Rectangle shape that was added to the Body.
*/
setRectangleFromSprite: function (sprite) {
if (sprite === undefined) { sprite = this.sprite; }
this.clearShapes();
return this.addRectangle(sprite.width, sprite.height, 0, 0, sprite.rotation);
},
/**
* Adds the given Material to all Shapes that belong to this Body.
* If you only wish to apply it to a specific Shape in this Body then provide that as the 2nd parameter.
*
* @method Phaser.Physics.P2.Body#setMaterial
* @param {Phaser.Physics.P2.Material} material - The Material that will be applied.
* @param {p2.Shape} [shape] - An optional Shape. If not provided the Material will be added to all Shapes in this Body.
*/
setMaterial: function (material, shape) {
if (shape === undefined)
{
for (var i = this.data.shapes.length - 1; i >= 0; i--)
{
this.data.shapes[i].material = material;
}
}
else
{
shape.material = material;
}
},
/**
* Updates the debug draw if any body shapes change.
*
* @method Phaser.Physics.P2.Body#shapeChanged
*/
shapeChanged: function() {
if (this.debugBody)
{
this.debugBody.draw();
}
},
/**
* Reads the shape data from a physics data file stored in the Game.Cache and adds it as a polygon to this Body.
* The shape data format is based on the custom phaser export in.
*
* @method Phaser.Physics.P2.Body#addPhaserPolygon
* @param {string} key - The key of the Physics Data file as stored in Game.Cache.
* @param {string} object - The key of the object within the Physics data file that you wish to load the shape data from.
*/
addPhaserPolygon: function (key, object) {
var data = this.game.cache.getPhysicsData(key, object);
var createdFixtures = [];
// Cycle through the fixtures
for (var i = 0; i < data.length; i++)
{
var fixtureData = data[i];
var shapesOfFixture = this.addFixture(fixtureData);
// Always add to a group
createdFixtures[fixtureData.filter.group] = createdFixtures[fixtureData.filter.group] || [];
createdFixtures[fixtureData.filter.group] = createdFixtures[fixtureData.filter.group].concat(shapesOfFixture);
// if (unique) fixture key is provided
if (fixtureData.fixtureKey)
{
createdFixtures[fixtureData.fixtureKey] = shapesOfFixture;
}
}
this.data.aabbNeedsUpdate = true;
this.shapeChanged();
return createdFixtures;
},
/**
* Add a polygon fixture. This is used during #loadPolygon.
*
* @method Phaser.Physics.P2.Body#addFixture
* @param {string} fixtureData - The data for the fixture. It contains: isSensor, filter (collision) and the actual polygon shapes.
* @return {array} An array containing the generated shapes for the given polygon.
*/
addFixture: function (fixtureData) {
var generatedShapes = [];
if (fixtureData.circle)
{
var shape = new p2.Circle({ radius: this.world.pxm(fixtureData.circle.radius) });
shape.collisionGroup = fixtureData.filter.categoryBits;
shape.collisionMask = fixtureData.filter.maskBits;
shape.sensor = fixtureData.isSensor;
var offset = p2.vec2.create();
offset[0] = this.world.pxmi(fixtureData.circle.position[0] - this.sprite.width/2);
offset[1] = this.world.pxmi(fixtureData.circle.position[1] - this.sprite.height/2);
this.data.addShape(shape, offset);
generatedShapes.push(shape);
}
else
{
var polygons = fixtureData.polygons;
var cm = p2.vec2.create();
for (var i = 0; i < polygons.length; i++)
{
var shapes = polygons[i];
var vertices = [];
for (var s = 0; s < shapes.length; s += 2)
{
vertices.push([ this.world.pxmi(shapes[s]), this.world.pxmi(shapes[s + 1]) ]);
}
var shape = new p2.Convex({ vertices: vertices });
// Move all vertices so its center of mass is in the local center of the convex
for (var j = 0; j !== shape.vertices.length; j++)
{
var v = shape.vertices[j];
p2.vec2.sub(v, v, shape.centerOfMass);
}
p2.vec2.scale(cm, shape.centerOfMass, 1);
cm[0] -= this.world.pxmi(this.sprite.width / 2);
cm[1] -= this.world.pxmi(this.sprite.height / 2);
shape.updateTriangles();
shape.updateCenterOfMass();
shape.updateBoundingRadius();
shape.collisionGroup = fixtureData.filter.categoryBits;
shape.collisionMask = fixtureData.filter.maskBits;
shape.sensor = fixtureData.isSensor;
this.data.addShape(shape, cm);
generatedShapes.push(shape);
}
}
return generatedShapes;
},
/**
* Reads the shape data from a physics data file stored in the Game.Cache and adds it as a polygon to this Body.
*
* As well as reading the data from the Cache you can also pass `null` as the first argument and a
* physics data object as the second. When doing this you must ensure the structure of the object is correct in advance.
*
* For more details see the format of the Lime / Corona Physics Editor export.
*
* @method Phaser.Physics.P2.Body#loadPolygon
* @param {string} key - The key of the Physics Data file as stored in Game.Cache. Alternatively set to `null` and pass the
* data as the 2nd argument.
* @param {string|object} object - The key of the object within the Physics data file that you wish to load the shape data from,
* or if key is null pass the actual physics data object itself as this parameter.
* @return {boolean} True on success, else false.
*/
loadPolygon: function (key, object) {
if (key === null)
{
var data = object;
}
else
{
var data = this.game.cache.getPhysicsData(key, object);
}
// We've multiple Convex shapes, they should be CCW automatically
var cm = p2.vec2.create();
for (var i = 0; i < data.length; i++)
{
var vertices = [];
for (var s = 0; s < data[i].shape.length; s += 2)
{
vertices.push([ this.world.pxmi(data[i].shape[s]), this.world.pxmi(data[i].shape[s + 1]) ]);
}
var c = new p2.Convex({ vertices: vertices });
// Move all vertices so its center of mass is in the local center of the convex
for (var j = 0; j !== c.vertices.length; j++)
{
var v = c.vertices[j];
p2.vec2.sub(v, v, c.centerOfMass);
}
p2.vec2.scale(cm, c.centerOfMass, 1);
cm[0] -= this.world.pxmi(this.sprite.width / 2);
cm[1] -= this.world.pxmi(this.sprite.height / 2);
c.updateTriangles();
c.updateCenterOfMass();
c.updateBoundingRadius();
this.data.addShape(c, cm);
}
this.data.aabbNeedsUpdate = true;
this.shapeChanged();
return true;
}
};
Phaser.Physics.P2.Body.prototype.constructor = Phaser.Physics.P2.Body;
/**
* Dynamic body. Dynamic bodies body can move and respond to collisions and forces.
* @property DYNAMIC
* @type {Number}
* @static
*/
Phaser.Physics.P2.Body.DYNAMIC = 1;
/**
* Static body. Static bodies do not move, and they do not respond to forces or collision.
* @property STATIC
* @type {Number}
* @static
*/
Phaser.Physics.P2.Body.STATIC = 2;
/**
* Kinematic body. Kinematic bodies only moves according to its .velocity, and does not respond to collisions or force.
* @property KINEMATIC
* @type {Number}
* @static
*/
Phaser.Physics.P2.Body.KINEMATIC = 4;
/**
* @name Phaser.Physics.P2.Body#static
* @property {boolean} static - Returns true if the Body is static. Setting Body.static to 'false' will make it dynamic.
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "static", {
get: function () {
return (this.data.type === Phaser.Physics.P2.Body.STATIC);
},
set: function (value) {
if (value && this.data.type !== Phaser.Physics.P2.Body.STATIC)
{
this.data.type = Phaser.Physics.P2.Body.STATIC;
this.mass = 0;
}
else if (!value && this.data.type === Phaser.Physics.P2.Body.STATIC)
{
this.data.type = Phaser.Physics.P2.Body.DYNAMIC;
this.mass = 1;
}
}
});
/**
* @name Phaser.Physics.P2.Body#dynamic
* @property {boolean} dynamic - Returns true if the Body is dynamic. Setting Body.dynamic to 'false' will make it static.
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "dynamic", {
get: function () {
return (this.data.type === Phaser.Physics.P2.Body.DYNAMIC);
},
set: function (value) {
if (value && this.data.type !== Phaser.Physics.P2.Body.DYNAMIC)
{
this.data.type = Phaser.Physics.P2.Body.DYNAMIC;
this.mass = 1;
}
else if (!value && this.data.type === Phaser.Physics.P2.Body.DYNAMIC)
{
this.data.type = Phaser.Physics.P2.Body.STATIC;
this.mass = 0;
}
}
});
/**
* @name Phaser.Physics.P2.Body#kinematic
* @property {boolean} kinematic - Returns true if the Body is kinematic. Setting Body.kinematic to 'false' will make it static.
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "kinematic", {
get: function () {
return (this.data.type === Phaser.Physics.P2.Body.KINEMATIC);
},
set: function (value) {
if (value && this.data.type !== Phaser.Physics.P2.Body.KINEMATIC)
{
this.data.type = Phaser.Physics.P2.Body.KINEMATIC;
this.mass = 4;
}
else if (!value && this.data.type === Phaser.Physics.P2.Body.KINEMATIC)
{
this.data.type = Phaser.Physics.P2.Body.STATIC;
this.mass = 0;
}
}
});
/**
* @name Phaser.Physics.P2.Body#allowSleep
* @property {boolean} allowSleep -
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "allowSleep", {
get: function () {
return this.data.allowSleep;
},
set: function (value) {
if (value !== this.data.allowSleep)
{
this.data.allowSleep = value;
}
}
});
/**
* The angle of the Body in degrees from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
* Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement Body.angle = 450 is the same as Body.angle = 90.
* If you wish to work in radians instead of degrees use the property Body.rotation instead. Working in radians is faster as it doesn't have to convert values.
*
* @name Phaser.Physics.P2.Body#angle
* @property {number} angle - The angle of this Body in degrees.
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "angle", {
get: function() {
return Phaser.Math.wrapAngle(Phaser.Math.radToDeg(this.data.angle));
},
set: function(value) {
this.data.angle = Phaser.Math.degToRad(Phaser.Math.wrapAngle(value));
}
});
/**
* Damping is specified as a value between 0 and 1, which is the proportion of velocity lost per second.
* @name Phaser.Physics.P2.Body#angularDamping
* @property {number} angularDamping - The angular damping acting acting on the body.
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "angularDamping", {
get: function () {
return this.data.angularDamping;
},
set: function (value) {
this.data.angularDamping = value;
}
});
/**
* @name Phaser.Physics.P2.Body#angularForce
* @property {number} angularForce - The angular force acting on the body.
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "angularForce", {
get: function () {
return this.data.angularForce;
},
set: function (value) {
this.data.angularForce = value;
}
});
/**
* @name Phaser.Physics.P2.Body#angularVelocity
* @property {number} angularVelocity - The angular velocity of the body.
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "angularVelocity", {
get: function () {
return this.data.angularVelocity;
},
set: function (value) {
this.data.angularVelocity = value;
}
});
/**
* Damping is specified as a value between 0 and 1, which is the proportion of velocity lost per second.
* @name Phaser.Physics.P2.Body#damping
* @property {number} damping - The linear damping acting on the body in the velocity direction.
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "damping", {
get: function () {
return this.data.damping;
},
set: function (value) {
this.data.damping = value;
}
});
/**
* @name Phaser.Physics.P2.Body#fixedRotation
* @property {boolean} fixedRotation -
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "fixedRotation", {
get: function () {
return this.data.fixedRotation;
},
set: function (value) {
if (value !== this.data.fixedRotation)
{
this.data.fixedRotation = value;
}
}
});
/**
* @name Phaser.Physics.P2.Body#inertia
* @property {number} inertia - The inertia of the body around the Z axis..
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "inertia", {
get: function () {
return this.data.inertia;
},
set: function (value) {
this.data.inertia = value;
}
});
/**
* @name Phaser.Physics.P2.Body#mass
* @property {number} mass - The mass of the body.
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "mass", {
get: function () {
return this.data.mass;
},
set: function (value) {
if (value !== this.data.mass)
{
this.data.mass = value;
this.data.updateMassProperties();
}
}
});
/**
* @name Phaser.Physics.P2.Body#motionState
* @property {number} motionState - The type of motion this body has. Should be one of: Body.STATIC (the body does not move), Body.DYNAMIC (body can move and respond to collisions) and Body.KINEMATIC (only moves according to its .velocity).
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "motionState", {
get: function () {
return this.data.type;
},
set: function (value) {
if (value !== this.data.type)
{
this.data.type = value;
}
}
});
/**
* The angle of the Body in radians.
* If you wish to work in degrees instead of radians use the Body.angle property instead. Working in radians is faster as it doesn't have to convert values.
*
* @name Phaser.Physics.P2.Body#rotation
* @property {number} rotation - The angle of this Body in radians.
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "rotation", {
get: function() {
return this.data.angle;
},
set: function(value) {
this.data.angle = value;
}
});
/**
* @name Phaser.Physics.P2.Body#sleepSpeedLimit
* @property {number} sleepSpeedLimit - .
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "sleepSpeedLimit", {
get: function () {
return this.data.sleepSpeedLimit;
},
set: function (value) {
this.data.sleepSpeedLimit = value;
}
});
/**
* @name Phaser.Physics.P2.Body#x
* @property {number} x - The x coordinate of this Body.
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "x", {
get: function () {
return this.world.mpxi(this.data.position[0]);
},
set: function (value) {
this.data.position[0] = this.world.pxmi(value);
}
});
/**
* @name Phaser.Physics.P2.Body#y
* @property {number} y - The y coordinate of this Body.
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "y", {
get: function () {
return this.world.mpxi(this.data.position[1]);
},
set: function (value) {
this.data.position[1] = this.world.pxmi(value);
}
});
/**
* @name Phaser.Physics.P2.Body#id
* @property {number} id - The Body ID. Each Body that has been added to the World has a unique ID.
* @readonly
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "id", {
get: function () {
return this.data.id;
}
});
/**
* @name Phaser.Physics.P2.Body#debug
* @property {boolean} debug - Enable or disable debug drawing of this body
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "debug", {
get: function () {
return (this.debugBody !== null);
},
set: function (value) {
if (value && !this.debugBody)
{
// This will be added to the global space
this.debugBody = new Phaser.Physics.P2.BodyDebug(this.game, this.data);
}
else if (!value && this.debugBody)
{
this.debugBody.destroy();
this.debugBody = null;
}
}
});
/**
* A Body can be set to collide against the World bounds automatically if this is set to true. Otherwise it will leave the World.
* Note that this only applies if your World has bounds! The response to the collision should be managed via CollisionMaterials.
* Also note that when you set this it will only effect Body shapes that already exist. If you then add further shapes to your Body
* after setting this it will *not* proactively set them to collide with the bounds.
*
* @name Phaser.Physics.P2.Body#collideWorldBounds
* @property {boolean} collideWorldBounds - Should the Body collide with the World bounds?
*/
Object.defineProperty(Phaser.Physics.P2.Body.prototype, "collideWorldBounds", {
get: function () {
return this._collideWorldBounds;
},
set: function (value) {
if (value && !this._collideWorldBounds)
{
this._collideWorldBounds = true;
this.updateCollisionMask();
}
else if (!value && this._collideWorldBounds)
{
this._collideWorldBounds = false;
this.updateCollisionMask();
}
}
});
</pre>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser Copyright © 2012-2015 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a>
on Mon Aug 24 2015 15:36:46 GMT+0100 (GMT Daylight Time) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>
|
andrelavru/Resource_phaser
|
docs/src_physics_p2_Body.js.html
|
HTML
|
mit
| 94,650 |
<!DOCTYPE html>
<html lang="en">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>CSS Test: font-variant-ligatures: normal; low level equivalence</title>
<link rel="author" title="Chris Lilley" href="[email protected]">
<link rel="help" href="https://www.w3.org/TR/css-fonts-3/#font-variant-ligatures-prop">
<link rel="help" href="https://www.w3.org/TR/css-fonts-3/#font-feature-settings-prop">
<link rel="match" href="font-variant-ligatures-01-ref.html">
<meta name="assert" content="common ligatures and contextual forms are on by default, discretionary and historical ligatures are not">
<style>
@font-face {
font-family: fwf;
src: url(support/fonts/FontWithFancyFeatures.otf);
}
.test {
font-family: fwf;
font-size: 3em;
line-height: 1.1;
}
.high {
font-variant-ligatures: normal;
}
.low {
font-feature-settings: "liga" on, "clig" on, "calt" on, "hlig" off, "dlig" off;
}
</style>
<body>
<p>Test passes if the three lines below are identical, with three check marks (✓) followed by two crosses (✗)</p>
<section class="test">
<p class="high">CDGFE</p>
<p class="low">CDGFE</p>
<p class="ref">AAABB</p>
</section>
|
scheib/chromium
|
third_party/blink/web_tests/external/wpt/css/css-fonts/font-variant-ligatures-01.html
|
HTML
|
bsd-3-clause
| 1,179 |
<section>
<div class="page-header">
<h1>User <span data-ng-bind="user.username"</span</h1>
</div>
<div class="col-md-12">
<form name="userForm" class="form-horizontal" data-ng-submit="update()" novalidate>
<fieldset>
<div class="form-group">
<label class="control-label" for="firstName">First Name</label>
<div class="controls">
<input name="firstName" type="text" data-ng-model="user.firstName" id="firstName" class="form-control" placeholder="First Name" required>
</div>
</div>
<div class="form-group">
<label class="control-label" for="lastName">Last Name</label>
<div class="controls">
<input type="text" name="lastName" data-ng-model="user.lastName" id="lastName" class="form-control" placeholder="Last Name" />
</div>
</div>
<div class="form-group">
<label class="control-label" for="roles">Roles</label>
<div class="controls">
<input class="form-control" type="text" name="roles" data-ng-model="user.roles" id="roles" ng-list />
</div>
</div>
<div class="form-group">
<input type="submit" value="Update" class="btn btn-default">
</div>
<div data-ng-show="error" class="text-danger">
<strong data-ng-bind="error"></strong>
</div>
</fieldset>
</form>
</div>
</section>
|
davaaana/sanhvv
|
public/modules/user/views/admin/user-edit.client.view.html
|
HTML
|
mit
| 1,433 |
{{try:}}{{=page_url}}{{except:}}{{pass}}
{{if filter_query:}}
{{=current.T("Notification")}}: {{=XML(filter_query)}}{{pass}}
{{if new is not None:}}{{new_title=current.T("The following Post has been added") if new == 1 else current.T("The following %(number)s Posts have been added") % dict(number=new)}}
{{=XML(new_title)}}:
{{for record in new_records:}}
{{=XML(" - ".join([str(v) for l, v in record[:3]]))}}
{{=XML(record[3][1])}}
{{pass}}{{pass}}
{{if upd is not None:}}{{upd_title=current.T("The following Post has been updated") if upd == 1 else current.T("The following %(number)s Posts have been updated") % dict(number=upd)}}
{{=XML(upd_title)}}:
{{for record in upd_records:}}
{{=XML(" - ".join([str(v) for l, v in record[:3]]))}}
{{=XML(record[3][1])}}
{{pass}}{{pass}}
|
devinbalkind/eden
|
private/templates/Syria/views/msg/notify_post_email.html
|
HTML
|
mit
| 781 |
<!DOCTYPE html>
<title>Element#requestFullscreen() for SVG svg element</title>
<script src="/resources/testharness.js"></script>
<script src="/resources/testharnessreport.js"></script>
<script src="../trusted-click.js"></script>
<div id="log"></div>
<svg></svg>
<script>
async_test(function(t)
{
var svg = document.querySelector("svg");
assert_true(svg instanceof SVGSVGElement);
trusted_request(t, svg, document.body);
document.onfullscreenchange = t.step_func_done();
document.onfullscreenerror = t.unreached_func("fullscreenerror event");
});
</script>
|
scheib/chromium
|
third_party/blink/web_tests/external/wpt/fullscreen/api/element-request-fullscreen-svg-svg-manual.html
|
HTML
|
bsd-3-clause
| 576 |
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Upgrading from 2.2.1 to 2.2.2 — CodeIgniter 3.0.1 documentation</title>
<link rel="shortcut icon" href="../_static/ci-icon.ico"/>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
<link rel="top" title="CodeIgniter 3.0.1 documentation" href="../index.html"/>
<link rel="up" title="Upgrading From a Previous Version" href="upgrading.html"/>
<link rel="next" title="Upgrading from 2.2.0 to 2.2.1" href="upgrade_221.html"/>
<link rel="prev" title="Upgrading from 2.2.2 to 2.2.3" href="upgrade_223.html"/>
<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="../index.html" class="fa fa-home"> CodeIgniter</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a><ul class="simple">
</ul>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Installation Instructions</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="downloads.html">Downloading CodeIgniter</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html">Installation Instructions</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="upgrading.html">Upgrading From a Previous Version</a></li>
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
</ul>
</li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">CodeIgniter</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li><a href="index.html">Installation Instructions</a> »</li>
<li><a href="upgrading.html">Upgrading From a Previous Version</a> »</li>
<li>Upgrading from 2.2.1 to 2.2.2</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<div class="section" id="upgrading-from-2-2-1-to-2-2-2">
<h1>Upgrading from 2.2.1 to 2.2.2<a class="headerlink" href="#upgrading-from-2-2-1-to-2-2-2" title="Permalink to this headline">¶</a></h1>
<p>Before performing an update you should take your site offline by
replacing the index.php file with a static one.</p>
<div class="section" id="step-1-update-your-codeigniter-files">
<h2>Step 1: Update your CodeIgniter files<a class="headerlink" href="#step-1-update-your-codeigniter-files" title="Permalink to this headline">¶</a></h2>
<p>Replace all files and directories in your “system” folder.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you have any custom developed files in these folders please
make copies of them first.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="upgrade_221.html" class="btn btn-neutral float-right" title="Upgrading from 2.2.0 to 2.2.1">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="upgrade_223.html" class="btn btn-neutral" title="Upgrading from 2.2.2 to 2.2.3"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014 - 2015, British Columbia Institute of Technology.
Last updated on Aug 07, 2015.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'3.0.1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: false
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|
1000VICKY/docgack.com
|
www/user_guide/installation/upgrade_222.html
|
HTML
|
mit
| 18,880 |
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>popstate event test</title>
</head>
<body>
<script>
(function() {
var test_id;
function showResult(r) {
if(test_id && window.parent.setResult) {
parent.setResult(test_id, r);
} else {
alert(r);
}
}
if(location.hash.length) {
test_id = location.hash.substr(1);
}
if(history.pushState) {
var rand = Math.random();
setTimeout(function() {
history.pushState({foo: 'bar'}, "title", './' + rand);
var result = (location.href.indexOf(rand) > -1);
showResult(result);
}, 100);
}
})();
</script>
</body>
</html>
|
frangucc/gamify
|
www/sandbox/pals/app/bower_components/modernizr/test/caniuse_files/pushstate.html
|
HTML
|
mit
| 616 |
<html>
<frameset cols="20%, 40%, 40%">
<frame src="chrome://selenium-ide/content/selenium-tests/tests/html/test_click_page2.html" id="frame1" name="frame1">
<frame src="chrome://selenium-ide/content/selenium-tests/tests/html/test_framed_page.html" name="frame2">
<frame src="chrome://selenium-ide/content/selenium-tests/tests/html/test_framed_page.html" name="frame3">
</frameset>
</html>
|
brownman/selenium-webdriver
|
ide/src/extension/content/tests/functional/aut/test_multi_level_frame2.html
|
HTML
|
apache-2.0
| 397 |
<html>
<!--
Copyright 2011 Software Freedom Conservancy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<head>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html">
</head><title>Open Test</title>
<body>
<img style="width: 644px; height: 41px;" alt="banner" src="banner.gif"><br>
This is a test of the open command.
</body>
</html>
|
jerome-jacob/selenium
|
java/server/test/org/openqa/selenium/tests/html/test_open.html
|
HTML
|
apache-2.0
| 821 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
Uses of Interface com.parse.ParseQueryAdapter.QueryFactory
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Interface com.parse.ParseQueryAdapter.QueryFactory";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../com/parse/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../com/parse/ParseQueryAdapter.QueryFactory.html" title="interface in com.parse"><FONT CLASS="NavBarFont1"><B>Class</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/parse//class-useParseQueryAdapter.QueryFactory.html" target="_top"><B>FRAMES</B></A>
<A HREF="ParseQueryAdapter.QueryFactory.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<CENTER>
<H2>
<B>Uses of Interface<br>com.parse.ParseQueryAdapter.QueryFactory</B></H2>
</CENTER>
<A NAME="com.parse"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
Uses of <A HREF="../../../com/parse/ParseQueryAdapter.QueryFactory.html" title="interface in com.parse">ParseQueryAdapter.QueryFactory</A> in <A HREF="../../../com/parse/package-summary.html">com.parse</A></FONT></TH>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left" COLSPAN="2">Constructors in <A HREF="../../../com/parse/package-summary.html">com.parse</A> with parameters of type <A HREF="../../../com/parse/ParseQueryAdapter.QueryFactory.html" title="interface in com.parse">ParseQueryAdapter.QueryFactory</A></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../com/parse/ParseQueryAdapter.html#ParseQueryAdapter(android.content.Context, com.parse.ParseQueryAdapter.QueryFactory)">ParseQueryAdapter</A></B>(<A target="_top" HREF="http://developer.android.com/reference/android/content/Context.html?is-external=true" title="class or interface in android.content">Context</A> context,
<A HREF="../../../com/parse/ParseQueryAdapter.QueryFactory.html" title="interface in com.parse">ParseQueryAdapter.QueryFactory</A><<A HREF="../../../com/parse/ParseQueryAdapter.html" title="type parameter in ParseQueryAdapter">T</A>> queryFactory)</CODE>
<BR>
Constructs a ParseQueryAdapter.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../com/parse/ParseQueryAdapter.html#ParseQueryAdapter(android.content.Context, com.parse.ParseQueryAdapter.QueryFactory, int)">ParseQueryAdapter</A></B>(<A target="_top" HREF="http://developer.android.com/reference/android/content/Context.html?is-external=true" title="class or interface in android.content">Context</A> context,
<A HREF="../../../com/parse/ParseQueryAdapter.QueryFactory.html" title="interface in com.parse">ParseQueryAdapter.QueryFactory</A><<A HREF="../../../com/parse/ParseQueryAdapter.html" title="type parameter in ParseQueryAdapter">T</A>> queryFactory,
int itemViewResource)</CODE>
<BR>
Constructs a ParseQueryAdapter.</TD>
</TR>
</TABLE>
<P>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../com/parse/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../com/parse/ParseQueryAdapter.QueryFactory.html" title="interface in com.parse"><FONT CLASS="NavBarFont1"><B>Class</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV
NEXT</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/parse//class-useParseQueryAdapter.QueryFactory.html" target="_top"><B>FRAMES</B></A>
<A HREF="ParseQueryAdapter.QueryFactory.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|
hzsweers/SUREwalk_android
|
surewalk/libs/Parse-1.4.0/Parse-1.4.0-javadoc/com/parse/class-use/ParseQueryAdapter.QueryFactory.html
|
HTML
|
mit
| 7,900 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<script language="javascript">
// Split a string in 2 parts. The first is the leading number, if any,
// the second is the string following the numbers.
function splitNum(s) {
var results = new Array();
results[0] = 'None';
for (var i = 0; i < s.length; i++) {
var substr = s.substr(0, i+1)
if (isNaN(substr)) {
// Not a number anymore.
results[1] = s.substr(i)
break;
} else {
// This is a number. update the results.
results[0] = parseFloat(substr);
}
}
return results;
}
// Compare 2 strings using a custom alphanumerical algorithm.
// This is similar to a normal string sort, except that we sort
// first by leading digits, if any.
// For example:
// 100hello > 2goodbye
// Numbers anywhere else in the string are compared using the normal
// sort algorithm.
function alphanumCompare(a, b) {
var parsedA = splitNum(a);
var parsedB = splitNum(b);
var numA = parsedA[0];
var numB = parsedB[0];
var strA = parsedA[1];
var strB = parsedB[1];
if (isNaN(numA) == false && isNaN(numB) == false) {
// They both start with numbers.
if (numA < numB) return -1;
if (numA > numB) return 1;
// Identical. Fallback to string.
return (strA < strB) ? -1 : (strA > strB ? 1 : 0)
}
// If only one starts with a number, we start with that one as
// the lowest.
if (isNaN(numA) == false) return -1
if (isNaN(numB) == false) return 1
// They are both strings.
return (a < b) ? -1 : (a > b ? 1 : 0)
}
</script>
</head>
<body>
<script type="application/javascript">
String.prototype.startsWith = function(str) {
return (this.match('^' + str) == str)
}
// Helper function to retrieve the value of a GET query parameter.
// Greatly inspired from http://alturl.com/8rj7a
function getParameter(parameterName) {
// Add '=' to the parameter name (i.e. parameterName=value)
var parameterName = parameterName + '=';
var queryString = window.location.search.substring(1);
if (queryString.length <= 0) {
return '';
}
// Find the beginning of the string
begin = queryString.indexOf(parameterName);
// If the parameter name is not found, skip it, otherwise return the
// value.
if (begin == -1) {
return '';
}
// Add the length (integer) to the beginning.
begin += parameterName.length;
// Multiple parameters are separated by the '&' sign.
end = queryString.indexOf ('&', begin);
if (end == -1) {
end = queryString.length;
}
// Return the string.
return unescape(queryString.substring(begin, end));
}
// Given a tag and a node, returns the value for this tag on this node.
function getNodeValue(node, tag) {
return node.getElementsByTagName(tag)[0].firstChild.nodeValue;
}
// Displays the directory listing given the XML and path.
function displayList(xmlstring, root, path, pathRoot) {
// Display the header
document.write('<h1>Index of /' + path + '</h1>');
// Start the table for the results.
document.write('<table style="border-spacing:15px 0px;">');
var sortOrder = getParameter('sort');
var sortLink = location.pathname + '?path=' + path;
if (sortOrder != 'desc') {
sortLink += '&sort=desc';
}
// Display the table header.
document.write('<tr><th><img src="' + root + pathRoot +
'icons/blank.gif" alt="[ICO]"></th>');
document.write('<th><a href="' + sortLink + '">Name</a></th>');
document.write('<th>Last modified</th>');
document.write('<th>Size</th>');
document.write('<th>Storage Class</th>');
document.write('<th>ETag</th></tr>');
document.write('<tr><th colspan="6"><hr></th></tr>');
// Display the 'go back' button.
if (path != '') {
var backpath = location.pathname;
// If there is more than one section delimited by '/' in the current
// path we truncate the last section and append the rest to backpath.
var delimiter = path.lastIndexOf('/');
if (delimiter >= 0) {
delimiter = path.substr(0, delimiter).lastIndexOf('/');
if (delimiter >= 0) {
backpath += '?path=';
backpath += path.substr(0, delimiter+1);
}
}
document.write('<tr><td valign="top"><img src="' + root + pathRoot +
'icons/back.gif" alt="[DIR]"></td>');
document.write('<td><a href="');
document.write(backpath);
document.write('">Parent Directory</a></td>');
document.write('<td> </td>');
document.write('<td align="right"> - </td></tr>');
}
// Set up the variables.
var directories = new Array();
var files = new Array();
for (var iter = 0; iter < xmlstrings.length; iter++) {
var xmlstring = xmlstrings[iter];
// Parse the XML output.
var parser = new DOMParser();
var xmlDoc = parser.parseFromString(xmlstring, 'text/xml');
// Get the main element.
var results = xmlDoc.getElementsByTagName('ListBucketResult');
// Get all the directories.
var prefixes = results[0].getElementsByTagName('CommonPrefixes');
for (var i = 0; i < prefixes.length; i++) {
var prefix = getNodeValue(prefixes[i], 'Prefix');
directories.push(prefix.substr(path.length));
}
// Get all the files.
var contents = results[0].getElementsByTagName('Contents');
for (var i = 0; i < contents.length; i++) {
var obj = new Object();
obj.keyName = getNodeValue(contents[i], 'Key');
obj.lastModified = getNodeValue(contents[i], 'LastModified');
obj.eTag = getNodeValue(contents[i], 'ETag');
obj.size = getNodeValue(contents[i], 'Size');
files.push(obj);
}
}
files.sort(alphanumCompare);
directories.sort(alphanumCompare);
// Reverse the list for a descending sort.
if (sortOrder == 'desc') {
files.reverse();
directories.reverse();
}
// Display the directories.
for (var i = 0; i < directories.length; i++) {
var lnk = location.pathname.substr(0, location.pathname.indexOf('?'));
lnk += '?path=' + path + directories[i];
document.write('<tr>');
document.write('<td valign="top"><img src="' + root + pathRoot +
'icons/folder.gif" alt="[DIR]"></td>');
document.write('<td><a href="' + lnk + '">' +
directories[i].split('/')[0] + '</a></td>');
document.write('<td align="right">-</td>');
document.write('<td align="right">-</td>');
document.write('<td align="right">-</td>');
document.write('<td align="right">-</td>');
document.write('</tr>');
}
// Display the files.
for (var i = 0; i < files.length; i++) {
var link = root + files[i].keyName;
var filename = files[i].keyName.substr(path.length);
var size = files[i].size / 1024 / 1024;
var lastModified = files[i].lastModified.replace('T', ' ');
lastModified = lastModified.substr(0, lastModified.indexOf('.'));
// Remove the entries we don't want to show.
if (filename == '') {
continue;
}
if (filename.indexOf('$folder$') >= 0) {
continue;
}
// Display the row.
document.write('<tr>');
document.write('<td valign="top"><img src="' + root + pathRoot +
'icons/binary.gif" alt="[DIR]"></td>');
document.write('<td><a href="' + link + '">' + filename +
'</a></td>');
document.write('<td align="right">' + lastModified + '</td>');
document.write('<td align="right">' + size.toFixed(2) + 'MB</td>');
document.write('<td align="right"><pre>' +
files[i].eTag.split('"')[1] + '</pre></td>');
document.write('</tr>');
}
// Close the table.
document.write('<tr><th colspan="6"><hr></th></tr>');
document.write('</table>');
}
var xmlstrings = new Array();
function fetchAndDisplay(marker) {
var path = getParameter('path');
var lastSlash = location.pathname.lastIndexOf("/");
var filename = location.pathname.substring(lastSlash + 1);
var firstSlash = location.pathname.indexOf("/", 1);
var root = location.pathname.substring(0, firstSlash + 1);
var pathRoot = location.pathname.substring(firstSlash + 1,
lastSlash + 1);
if (!path) {
path = location.pathname.substring(firstSlash + 1, lastSlash + 1);
}
var markerParam = '';
if (marker != '') {
markerParam = '&marker=' + marker;
}
var http = new XMLHttpRequest();
http.open('GET',
root + '?delimiter=/&prefix=' + path + markerParam,
true);
http.onreadystatechange = useHttpResponse;
http.send(null);
function useHttpResponse() {
if (http.readyState == 4) {
var xmlstring = http.responseText;
xmlstrings.push(xmlstring);
// Check if the data is truncated. if so, we need to request the
// rest.
var parser = new DOMParser();
var xmlDoc = parser.parseFromString(xmlstring, 'text/xml');
// Get the main element.
var results = xmlDoc.getElementsByTagName('ListBucketResult');
// Get IsTruncated.
var truncated = getNodeValue(results[0], 'IsTruncated');
var nextMarker = '';
if (truncated == 'true') {
nextMarker = getNodeValue(results[0], 'NextMarker');
fetchAndDisplay(nextMarker);
} else {
displayList(xmlstrings, root, path, pathRoot);
}
}
}
}
fetchAndDisplay('');
</script>
</body>
</html>
|
plxaye/chromium
|
src/native_client_sdk/src/web/index.html
|
HTML
|
apache-2.0
| 11,055 |
<!DOCTYPE html>
<html>
<body>
<form action="javascript:updateDom()">
<label for="typer">New label text:</label>
<input name="typer" type="text"/>
<br/>
<label for="color">Select label color:</label>
<input name="color" id="red" value="red" type="radio"/>Red
<input name="color" id="green" value="green" type="radio"/>Green
<br/>
<input name="submit" type="submit" value="Add Label"/>
</form>
<div id="update_butter" style="display:none"></div>
<script>
var butter = document.getElementById('update_butter');
var textProperty = butter['innerText'] ? 'innerText' : 'textContent';
var listeners = [];
function registerListener(fn) {
listeners.push(fn);
}
function updateDom() {
butter.style.display = 'block';
butter[textProperty] = 'Updating';
disableForm();
tick();
}
function disableForm() {
var inputs = document.getElementsByTagName('input');
for (var i = 0, input; input = inputs[i]; ++i) {
input.disabled = true;
}
}
function enableForm() {
var inputs = document.getElementsByTagName('input');
for (var i = 0, input; input = inputs[i]; ++i) {
input.disabled = false;
}
}
function tick() {
var length = butter[textProperty].substring('Updating'.length).length;
if (length != 10) {
butter[textProperty] += '.';
window.setTimeout(tick, 500);
} else {
enableForm();
var div = document.createElement('div');
var colors = document.forms[0].color;
for (var i = 0, color; color = colors[i]; ++i) {
if (color.checked) {
div.style.backgroundColor = color.value;
break;
}
}
div[textProperty] = document.forms[0].typer.value;
div.className = 'label';
document.forms[0].typer.value = '';
document.body.appendChild(div);
butter[textProperty] = 'Done!';
window.setTimeout(function() {
while (listeners.length) {
try {
listeners.shift()(div[textProperty]);
} catch (e) {
butter[textProperty] = "Exception seen: " + e;
}
}
}, 500);
}
}
</script>
</body>
</html>
|
vendavo/yowie
|
yowie-web/node_modules/protractor/node_modules/selenium-webdriver/lib/test/data/ajaxy_page.html
|
HTML
|
mit
| 2,160 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta name="Content-Type" content="text/html; charset=UTF-8" />
<title>Module: MasterMayI::ActiveRecordExtensions::InstanceMethods</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '../..';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (I)</a> »
<a href="../../MasterMayI.html" title="MasterMayI">MasterMayI</a> » <a href="../ActiveRecordExtensions.html" title="ActiveRecordExtensions">ActiveRecordExtensions</a>
»
<span class="title">InstanceMethods</span>
</div>
<div id="search">
<a id="class_list_link" href="#">Namespace List</a>
<a id="method_list_link" href="#">Method List</a>
<a id ="file_list_link" href="#">File List</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: MasterMayI::ActiveRecordExtensions::InstanceMethods
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/master_may_i/active_record_extensions.rb</dd>
</dl>
<div class="clear"></div>
<h2>Method Summary</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature"><a href="#destroyable%3F-instance_method" title="#destroyable? (instance method)">- (Object) <strong>destroyable?</strong> </a>
</span>
<span class="summary_desc">
Should the current user be able to destroy this record? Delegates to
<tt>destroyable_by?</tt>.
</span>
</li>
<li class="public ">
<span class="summary_signature"><a href="#destroyable_by%3F-instance_method" title="#destroyable_by? (instance method)">- (Object) <strong>destroyable_by?</strong>(user) </a>
</span>
<span class="summary_desc">
Should the given user be able to destroy this record? This method should be
redefined inside the model.
</span>
</li>
<li class="public ">
<span class="summary_signature"><a href="#editable%3F-instance_method" title="#editable? (instance method)">- (Object) <strong>editable?</strong> </a>
</span>
<span class="summary_desc">
Should the current user be able to edit this record? Delegates to
<tt>editable_by?</tt>.
</span>
</li>
<li class="public ">
<span class="summary_signature"><a href="#editable_by%3F-instance_method" title="#editable_by? (instance method)">- (Object) <strong>editable_by?</strong>(user) </a>
</span>
<span class="summary_desc">
Should the given user be able to edit this record? This method should be
redefined inside the model.
</span>
</li>
<li class="public ">
<span class="summary_signature"><a href="#readable%3F-instance_method" title="#readable? (instance method)">- (Object) <strong>readable?</strong> </a>
</span>
<span class="summary_desc">
Should the current user be able to read this record? Delegates to
<tt>readable_by?</tt>.
</span>
</li>
<li class="public ">
<span class="summary_signature"><a href="#readable_by%3F-instance_method" title="#readable_by? (instance method)">- (Object) <strong>readable_by?</strong>(user) </a>
</span>
<span class="summary_desc">
Should the given user be able to read this record? This method should be
redefined inside the model.
</span>
</li>
<li class="public ">
<span class="summary_signature"><a href="#user_from_session-instance_method" title="#user_from_session (instance method)">- (Object) <strong>user_from_session</strong> </a>
</span>
<span class="summary_desc">
Returns the currently logged in user via the Authlogic UserSession class.
</span>
</li>
</ul>
<div id="method_details">
<h2>Method Details</h2>
<div class="method_details first">
<p class="signature first" id="destroyable?-instance_method">
- (<tt>Object</tt>) <strong>destroyable?</strong>
</p><div class="docstring">
<div class="discussion">
<p>
Should the current user be able to destroy this record? Delegates to
<tt>destroyable_by?</tt>.
</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
174
175
176</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/master_may_i/active_record_extensions.rb', line 174</span>
<span class='def def kw'>def</span> <span class='destroyable? fid id'>destroyable?</span>
<span class='destroyable_by? fid id'>destroyable_by?</span><span class='lparen token'>(</span><span class='user_from_session identifier id'>user_from_session</span><span class='rparen token'>)</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="destroyable_by?-instance_method">
- (<tt>Object</tt>) <strong>destroyable_by?</strong>(user)
</p><div class="docstring">
<div class="discussion">
<p>
Should the given user be able to destroy this record? This method should be
redefined inside the model.
</p>
</div>
</div>
<div class="tags">
<h3>Parameters:</h3>
<ul class="param">
<li>
<span class='type'>(<tt>User</tt>, <tt>nil</tt>)</span>
<span class='name'>user</span>
—
Either a user record, or nil for visitors.
</li>
</ul>
<h3>See Also:</h3>
<ul class="see">
<li><a href="../../ActiveSupport/TestCase.html#should_be_destroyable_by-class_method" title="should_be_destroyable_by">should_be_destroyable_by</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
184
185
186</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/master_may_i/active_record_extensions.rb', line 184</span>
<span class='def def kw'>def</span> <span class='destroyable_by? fid id'>destroyable_by?</span><span class='lparen token'>(</span><span class='user identifier id'>user</span><span class='rparen token'>)</span>
<span class='true true kw'>true</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="editable?-instance_method">
- (<tt>Object</tt>) <strong>editable?</strong>
</p><div class="docstring">
<div class="discussion">
<p>
Should the current user be able to edit this record? Delegates to
<tt>editable_by?</tt>.
</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
159
160
161</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/master_may_i/active_record_extensions.rb', line 159</span>
<span class='def def kw'>def</span> <span class='editable? fid id'>editable?</span>
<span class='editable_by? fid id'>editable_by?</span><span class='lparen token'>(</span><span class='user_from_session identifier id'>user_from_session</span><span class='rparen token'>)</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="editable_by?-instance_method">
- (<tt>Object</tt>) <strong>editable_by?</strong>(user)
</p><div class="docstring">
<div class="discussion">
<p>
Should the given user be able to edit this record? This method should be
redefined inside the model.
</p>
</div>
</div>
<div class="tags">
<h3>Parameters:</h3>
<ul class="param">
<li>
<span class='type'>(<tt>User</tt>, <tt>nil</tt>)</span>
<span class='name'>user</span>
—
Either a user record, or nil for visitors.
</li>
</ul>
<h3>See Also:</h3>
<ul class="see">
<li><a href="../../ActiveSupport/TestCase.html#should_be_editable_by-class_method" title="should_be_editable_by">should_be_editable_by</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
169
170
171</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/master_may_i/active_record_extensions.rb', line 169</span>
<span class='def def kw'>def</span> <span class='editable_by? fid id'>editable_by?</span><span class='lparen token'>(</span><span class='user identifier id'>user</span><span class='rparen token'>)</span>
<span class='true true kw'>true</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="readable?-instance_method">
- (<tt>Object</tt>) <strong>readable?</strong>
</p><div class="docstring">
<div class="discussion">
<p>
Should the current user be able to read this record? Delegates to
<tt>readable_by?</tt>.
</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
144
145
146</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/master_may_i/active_record_extensions.rb', line 144</span>
<span class='def def kw'>def</span> <span class='readable? fid id'>readable?</span>
<span class='readable_by? fid id'>readable_by?</span><span class='lparen token'>(</span><span class='user_from_session identifier id'>user_from_session</span><span class='rparen token'>)</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="readable_by?-instance_method">
- (<tt>Object</tt>) <strong>readable_by?</strong>(user)
</p><div class="docstring">
<div class="discussion">
<p>
Should the given user be able to read this record? This method should be
redefined inside the model.
</p>
</div>
</div>
<div class="tags">
<h3>Parameters:</h3>
<ul class="param">
<li>
<span class='type'>(<tt>User</tt>, <tt>nil</tt>)</span>
<span class='name'>user</span>
—
Either a user record, or nil for visitors.
</li>
</ul>
<h3>See Also:</h3>
<ul class="see">
<li><a href="../../ActiveSupport/TestCase.html#should_be_readable_by-class_method" title="should_be_readable_by">should_be_readable_by</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
154
155
156</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/master_may_i/active_record_extensions.rb', line 154</span>
<span class='def def kw'>def</span> <span class='readable_by? fid id'>readable_by?</span><span class='lparen token'>(</span><span class='user identifier id'>user</span><span class='rparen token'>)</span>
<span class='true true kw'>true</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="user_from_session-instance_method">
- (<tt>Object</tt>) <strong>user_from_session</strong>
</p><div class="docstring">
<div class="discussion">
<p>
Returns the currently logged in user via the Authlogic UserSession class.
</p>
</div>
</div>
<div class="tags">
<h3>See Also:</h3>
<ul class="see">
<li><a href="ClassMethods.html#user_from_session-instance_method" title="user_from_session">user_from_session</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
190
191
192</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/master_may_i/active_record_extensions.rb', line 190</span>
<span class='def def kw'>def</span> <span class='user_from_session identifier id'>user_from_session</span>
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='class identifier id'>class</span><span class='dot token'>.</span><span class='user_from_session identifier id'>user_from_session</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Dec 23 03:17:29 2009 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.4.0 (ruby-1.8.6).
</div>
</body>
</html>
|
tsaleh/master-may-i
|
doc/MasterMayI/ActiveRecordExtensions/InstanceMethods.html
|
HTML
|
mit
| 13,102 |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>mathcomp-multinomials: Not compatible 👼</title>
<link rel="shortcut icon" type="image/png" href="../../../../../favicon.png" />
<link href="../../../../../bootstrap.min.css" rel="stylesheet">
<link href="../../../../../bootstrap-custom.css" rel="stylesheet">
<link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
<script src="../../../../../moment.min.js"></script>
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container">
<div class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<a class="navbar-brand" href="../../../../.."><i class="fa fa-lg fa-flag-checkered"></i> Coq bench</a>
</div>
<div id="navbar" class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="../..">clean / released</a></li>
<li class="active"><a href="">8.6 / mathcomp-multinomials - 1.4</a></li>
</ul>
</div>
</div>
</div>
<div class="article">
<div class="row">
<div class="col-md-12">
<a href="../..">« Up</a>
<h1>
mathcomp-multinomials
<small>
1.4
<span class="label label-info">Not compatible 👼</span>
</small>
</h1>
<p>📅 <em><script>document.write(moment("2021-12-14 11:53:07 +0000", "YYYY-MM-DD HH:mm:ss Z").fromNow());</script> (2021-12-14 11:53:07 UTC)</em><p>
<h2>Context</h2>
<pre># Packages matching: installed
# Name # Installed # Synopsis
base-bigarray base
base-num base Num library distributed with the OCaml compiler
base-ocamlbuild base OCamlbuild binary and libraries distributed with the OCaml compiler
base-threads base
base-unix base
camlp5 7.14 Preprocessor-pretty-printer of OCaml
conf-findutils 1 Virtual package relying on findutils
conf-perl 1 Virtual package relying on perl
coq 8.6 Formal proof management system
num 0 The Num library for arbitrary-precision integer and rational arithmetic
ocaml 4.02.3 The OCaml compiler (virtual package)
ocaml-base-compiler 4.02.3 Official 4.02.3 release
ocaml-config 1 OCaml Switch Configuration
ocamlfind 1.9.1 A library manager for OCaml
# opam file:
opam-version: "2.0"
name: "coq-mathcomp-multinomials"
maintainer: "[email protected]"
homepage: "https://github.com/math-comp/multinomials"
bug-reports: "https://github.com/math-comp/multinomials/issues"
dev-repo: "git+https://github.com/math-comp/multinomials.git"
license: "CeCILL-B"
authors: ["Pierre-Yves Strub"]
build: [
[make "INSTMODE=global" "config"]
[make "-j%{jobs}%"]
]
install: [
[make "install"]
]
depends: [
"coq" {>= "8.7" & < "8.12~"}
"coq-mathcomp-ssreflect" {(>= "1.8.0" & < "1.11~")}
"coq-mathcomp-algebra"
"coq-mathcomp-bigenough" {>= "1.0.0" & < "1.1~"}
"coq-mathcomp-finmap" {>= "1.3.4" & < "1.4~"}
]
tags: [
"keyword:multinomials"
"keyword:monoid algebra"
"category:Math/Algebra/Multinomials"
"category:Math/Algebra/Monoid algebra"
"date:2019-11-28"
"logpath:SsrMultinomials"
]
synopsis: "A Multivariate polynomial Library for the Mathematical Components Library"
url {
src: "https://github.com/math-comp/multinomials/archive/1.4.tar.gz"
checksum: "sha512=b8c4f750063b8764275ea3b0ca12b2bbc16d1c52c5b10bd71ef6d6bb0791ecfb1115681c4379ffe286ab8c550c1965ba08cd2c3a1e5600d8b1a17dee627e2aae"
}
</pre>
<h2>Lint</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
</dl>
<h2>Dry install 🏜️</h2>
<p>Dry install with the current Coq version:</p>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>opam install -y --show-action coq-mathcomp-multinomials.1.4 coq.8.6</code></dd>
<dt>Return code</dt>
<dd>5120</dd>
<dt>Output</dt>
<dd><pre>[NOTE] Package coq is already installed (current version is 8.6).
The following dependencies couldn't be met:
- coq-mathcomp-multinomials -> coq >= 8.7 -> ocaml >= 4.05.0
base of this switch (use `--unlock-base' to force)
Your request can't be satisfied:
- No available version of coq satisfies the constraints
No solution found, exiting
</pre></dd>
</dl>
<p>Dry install without Coq/switch base, to test if the problem was incompatibility with the current Coq/OCaml version:</p>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>opam remove -y coq; opam install -y --show-action --unlock-base coq-mathcomp-multinomials.1.4</code></dd>
<dt>Return code</dt>
<dd>0</dd>
</dl>
<h2>Install dependencies</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
<dt>Duration</dt>
<dd>0 s</dd>
</dl>
<h2>Install 🚀</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
<dt>Duration</dt>
<dd>0 s</dd>
</dl>
<h2>Installation size</h2>
<p>No files were installed.</p>
<h2>Uninstall 🧹</h2>
<dl class="dl-horizontal">
<dt>Command</dt>
<dd><code>true</code></dd>
<dt>Return code</dt>
<dd>0</dd>
<dt>Missing removes</dt>
<dd>
none
</dd>
<dt>Wrong removes</dt>
<dd>
none
</dd>
</dl>
</div>
</div>
</div>
<hr/>
<div class="footer">
<p class="text-center">
Sources are on <a href="https://github.com/coq-bench">GitHub</a> © Guillaume Claret 🐣
</p>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script src="../../../../../bootstrap.min.js"></script>
</body>
</html>
|
coq-bench/coq-bench.github.io
|
clean/Linux-x86_64-4.02.3-2.0.6/released/8.6/mathcomp-multinomials/1.4.html
|
HTML
|
mit
| 7,548 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html id="htmlId">
<head>
<title>Coverage Report :: MedlineImporter</title>
<style type="text/css">
@import "../../.css/coverage.css";
</style>
</head>
<body>
<div class="header"></div>
<div class="content">
<div class="breadCrumbs">
[ <a href="../../index.html">all classes</a> ]
[ <a href="../index.html">net.sf.jabref.logic.importer.fileformat</a> ]
</div>
<h1>Coverage Summary for Class: MedlineImporter (net.sf.jabref.logic.importer.fileformat)</h1>
<table class="coverageStats">
<tr>
<th class="name">Class</th>
<th class="coverageStat
">
Class, %
</th>
<th class="coverageStat
">
Method, %
</th>
<th class="coverageStat
">
Line, %
</th>
</tr>
<tr>
<td class="name">MedlineImporter</td>
<td class="coverageStat">
<span class="percent">
0%
</span>
<span class="absValue">
(0/ 1)
</span>
</td>
<td class="coverageStat">
<span class="percent">
0%
</span>
<span class="absValue">
(0/ 35)
</span>
</td>
<td class="coverageStat">
<span class="percent">
0%
</span>
<span class="absValue">
(0/ 389)
</span>
</td>
</tr>
</table>
<br/>
<br/>
<div class="sourceCode"><i>1</i> package net.sf.jabref.logic.importer.fileformat;
<i>2</i>
<i>3</i> import java.io.BufferedReader;
<i>4</i> import java.io.IOException;
<i>5</i> import java.io.InputStream;
<i>6</i> import java.io.InputStreamReader;
<i>7</i> import java.io.Serializable;
<i>8</i> import java.nio.charset.StandardCharsets;
<i>9</i> import java.util.ArrayList;
<i>10</i> import java.util.Collections;
<i>11</i> import java.util.HashMap;
<i>12</i> import java.util.List;
<i>13</i> import java.util.Locale;
<i>14</i> import java.util.Map;
<i>15</i> import java.util.Objects;
<i>16</i>
<i>17</i> import javax.xml.bind.JAXBContext;
<i>18</i> import javax.xml.bind.JAXBElement;
<i>19</i> import javax.xml.bind.JAXBException;
<i>20</i> import javax.xml.bind.Unmarshaller;
<i>21</i> import javax.xml.stream.XMLInputFactory;
<i>22</i> import javax.xml.stream.XMLStreamException;
<i>23</i> import javax.xml.stream.XMLStreamReader;
<i>24</i>
<i>25</i> import net.sf.jabref.logic.importer.Importer;
<i>26</i> import net.sf.jabref.logic.importer.ParseException;
<i>27</i> import net.sf.jabref.logic.importer.Parser;
<i>28</i> import net.sf.jabref.logic.importer.ParserResult;
<i>29</i> import net.sf.jabref.logic.importer.fileformat.medline.Abstract;
<i>30</i> import net.sf.jabref.logic.importer.fileformat.medline.AbstractText;
<i>31</i> import net.sf.jabref.logic.importer.fileformat.medline.AffiliationInfo;
<i>32</i> import net.sf.jabref.logic.importer.fileformat.medline.ArticleId;
<i>33</i> import net.sf.jabref.logic.importer.fileformat.medline.ArticleIdList;
<i>34</i> import net.sf.jabref.logic.importer.fileformat.medline.ArticleTitle;
<i>35</i> import net.sf.jabref.logic.importer.fileformat.medline.Author;
<i>36</i> import net.sf.jabref.logic.importer.fileformat.medline.AuthorList;
<i>37</i> import net.sf.jabref.logic.importer.fileformat.medline.Book;
<i>38</i> import net.sf.jabref.logic.importer.fileformat.medline.BookDocument;
<i>39</i> import net.sf.jabref.logic.importer.fileformat.medline.BookTitle;
<i>40</i> import net.sf.jabref.logic.importer.fileformat.medline.Chemical;
<i>41</i> import net.sf.jabref.logic.importer.fileformat.medline.ContributionDate;
<i>42</i> import net.sf.jabref.logic.importer.fileformat.medline.DateCompleted;
<i>43</i> import net.sf.jabref.logic.importer.fileformat.medline.DateCreated;
<i>44</i> import net.sf.jabref.logic.importer.fileformat.medline.DateRevised;
<i>45</i> import net.sf.jabref.logic.importer.fileformat.medline.ELocationID;
<i>46</i> import net.sf.jabref.logic.importer.fileformat.medline.GeneSymbolList;
<i>47</i> import net.sf.jabref.logic.importer.fileformat.medline.GeneralNote;
<i>48</i> import net.sf.jabref.logic.importer.fileformat.medline.ISSN;
<i>49</i> import net.sf.jabref.logic.importer.fileformat.medline.Investigator;
<i>50</i> import net.sf.jabref.logic.importer.fileformat.medline.InvestigatorList;
<i>51</i> import net.sf.jabref.logic.importer.fileformat.medline.Journal;
<i>52</i> import net.sf.jabref.logic.importer.fileformat.medline.JournalIssue;
<i>53</i> import net.sf.jabref.logic.importer.fileformat.medline.Keyword;
<i>54</i> import net.sf.jabref.logic.importer.fileformat.medline.KeywordList;
<i>55</i> import net.sf.jabref.logic.importer.fileformat.medline.MedlineCitation;
<i>56</i> import net.sf.jabref.logic.importer.fileformat.medline.MedlineJournalInfo;
<i>57</i> import net.sf.jabref.logic.importer.fileformat.medline.MeshHeading;
<i>58</i> import net.sf.jabref.logic.importer.fileformat.medline.MeshHeadingList;
<i>59</i> import net.sf.jabref.logic.importer.fileformat.medline.OtherID;
<i>60</i> import net.sf.jabref.logic.importer.fileformat.medline.Pagination;
<i>61</i> import net.sf.jabref.logic.importer.fileformat.medline.PersonalNameSubject;
<i>62</i> import net.sf.jabref.logic.importer.fileformat.medline.PersonalNameSubjectList;
<i>63</i> import net.sf.jabref.logic.importer.fileformat.medline.PubDate;
<i>64</i> import net.sf.jabref.logic.importer.fileformat.medline.PublicationType;
<i>65</i> import net.sf.jabref.logic.importer.fileformat.medline.Publisher;
<i>66</i> import net.sf.jabref.logic.importer.fileformat.medline.PubmedArticle;
<i>67</i> import net.sf.jabref.logic.importer.fileformat.medline.PubmedArticleSet;
<i>68</i> import net.sf.jabref.logic.importer.fileformat.medline.PubmedBookArticle;
<i>69</i> import net.sf.jabref.logic.importer.fileformat.medline.PubmedBookArticleSet;
<i>70</i> import net.sf.jabref.logic.importer.fileformat.medline.PubmedBookData;
<i>71</i> import net.sf.jabref.logic.importer.fileformat.medline.QualifierName;
<i>72</i> import net.sf.jabref.logic.importer.fileformat.medline.Section;
<i>73</i> import net.sf.jabref.logic.importer.fileformat.medline.Sections;
<i>74</i> import net.sf.jabref.logic.importer.fileformat.medline.Text;
<i>75</i> import net.sf.jabref.logic.util.FileExtensions;
<i>76</i> import net.sf.jabref.model.entry.BibEntry;
<i>77</i> import net.sf.jabref.model.entry.FieldName;
<i>78</i> import net.sf.jabref.model.strings.StringUtil;
<i>79</i>
<i>80</i> import com.google.common.base.Joiner;
<i>81</i> import org.apache.commons.logging.Log;
<i>82</i> import org.apache.commons.logging.LogFactory;
<i>83</i>
<i>84</i> /**
<i>85</i> * Importer for the Medline/Pubmed format.
<i>86</i> * <p>
<i>87</i> * check here for details on the format
<i>88</i> * https://www.nlm.nih.gov/bsd/licensee/elements_descriptions.html
<i>89</i> */
<b class="nc"><i>90</i> public class MedlineImporter extends Importer implements Parser {</b>
<i>91</i>
<b class="nc"><i>92</i> private static final Log LOGGER = LogFactory.getLog(MedlineImporter.class);</b>
<i>93</i> private static final String KEYWORD_SEPARATOR = "; ";
<i>94</i>
<b class="nc"><i>95</i> private static final Locale ENGLISH = Locale.ENGLISH;</b>
<i>96</i>
<i>97</i> private static String join(List<String> list, String string) {
<b class="nc"><i>98</i> return Joiner.on(string).join(list);</b>
<i>99</i> }
<i>100</i>
<i>101</i> @Override
<i>102</i> public String getName() {
<b class="nc"><i>103</i> return "Medline";</b>
<i>104</i> }
<i>105</i>
<i>106</i> @Override
<i>107</i> public FileExtensions getExtensions() {
<b class="nc"><i>108</i> return FileExtensions.MEDLINE;</b>
<i>109</i> }
<i>110</i>
<i>111</i> @Override
<i>112</i> public String getId() {
<b class="nc"><i>113</i> return "medline";</b>
<i>114</i> }
<i>115</i>
<i>116</i> @Override
<i>117</i> public String getDescription() {
<b class="nc"><i>118</i> return "Importer for the Medline format.";</b>
<i>119</i> }
<i>120</i>
<i>121</i> @Override
<i>122</i> public boolean isRecognizedFormat(BufferedReader reader) throws IOException {
<i>123</i> String str;
<b class="nc"><i>124</i> int i = 0;</b>
<b class="nc"><i>125</i> while (((str = reader.readLine()) != null) && (i < 50)) {</b>
<i>126</i>
<b class="nc"><i>127</i> if (str.toLowerCase(ENGLISH).contains("<pubmedarticle>")</b>
<b class="nc"><i>128</i> || str.toLowerCase(ENGLISH).contains("<pubmedbookarticle>")) {</b>
<b class="nc"><i>129</i> return true;</b>
<i>130</i> }
<i>131</i>
<b class="nc"><i>132</i> i++;</b>
<i>133</i> }
<b class="nc"><i>134</i> return false;</b>
<i>135</i> }
<i>136</i>
<i>137</i> @Override
<i>138</i> public ParserResult importDatabase(BufferedReader reader) throws IOException {
<b class="nc"><i>139</i> Objects.requireNonNull(reader);</b>
<i>140</i>
<b class="nc"><i>141</i> List<BibEntry> bibItems = new ArrayList<>();</b>
<i>142</i>
<i>143</i> try {
<b class="nc"><i>144</i> JAXBContext context = JAXBContext.newInstance("net.sf.jabref.logic.csv_importer.fileformat.medline");</b>
<b class="nc"><i>145</i> XMLInputFactory xmlInputFactory = XMLInputFactory.newFactory();</b>
<b class="nc"><i>146</i> XMLStreamReader xmlStreamReader = xmlInputFactory.createXMLStreamReader(reader);</b>
<i>147</i>
<i>148</i> //go to the root element
<b class="nc"><i>149</i> while (!xmlStreamReader.isStartElement()) {</b>
<b class="nc"><i>150</i> xmlStreamReader.next();</b>
<i>151</i> }
<i>152</i>
<b class="nc"><i>153</i> Unmarshaller unmarshaller = context.createUnmarshaller();</b>
<b class="nc"><i>154</i> Object unmarshalledObject = unmarshaller.unmarshal(xmlStreamReader);</b>
<i>155</i>
<i>156</i> //check whether we have an article set, an article, a book article or a book article set
<b class="nc"><i>157</i> if (unmarshalledObject instanceof PubmedArticleSet) {</b>
<b class="nc"><i>158</i> PubmedArticleSet articleSet = (PubmedArticleSet) unmarshalledObject;</b>
<b class="nc"><i>159</i> for (Object article : articleSet.getPubmedArticleOrPubmedBookArticle()) {</b>
<b class="nc"><i>160</i> if (article instanceof PubmedArticle) {</b>
<b class="nc"><i>161</i> PubmedArticle currentArticle = (PubmedArticle) article;</b>
<b class="nc"><i>162</i> parseArticle(currentArticle, bibItems);</b>
<i>163</i> }
<b class="nc"><i>164</i> if (article instanceof PubmedBookArticle) {</b>
<b class="nc"><i>165</i> PubmedBookArticle currentArticle = (PubmedBookArticle) article;</b>
<b class="nc"><i>166</i> parseBookArticle(currentArticle, bibItems);</b>
<i>167</i> }
<b class="nc"><i>168</i> }</b>
<b class="nc"><i>169</i> } else if (unmarshalledObject instanceof PubmedArticle) {</b>
<b class="nc"><i>170</i> PubmedArticle article = (PubmedArticle) unmarshalledObject;</b>
<b class="nc"><i>171</i> parseArticle(article, bibItems);</b>
<b class="nc"><i>172</i> } else if (unmarshalledObject instanceof PubmedBookArticle) {</b>
<b class="nc"><i>173</i> PubmedBookArticle currentArticle = (PubmedBookArticle) unmarshalledObject;</b>
<b class="nc"><i>174</i> parseBookArticle(currentArticle, bibItems);</b>
<b class="nc"><i>175</i> } else {</b>
<b class="nc"><i>176</i> PubmedBookArticleSet bookArticleSet = (PubmedBookArticleSet) unmarshalledObject;</b>
<b class="nc"><i>177</i> for (PubmedBookArticle bookArticle : bookArticleSet.getPubmedBookArticle()) {</b>
<b class="nc"><i>178</i> parseBookArticle(bookArticle, bibItems);</b>
<b class="nc"><i>179</i> }</b>
<i>180</i> }
<b class="nc"><i>181</i> } catch (JAXBException | XMLStreamException e) {</b>
<b class="nc"><i>182</i> LOGGER.debug("could not parse document", e);</b>
<b class="nc"><i>183</i> return ParserResult.fromError(e);</b>
<b class="nc"><i>184</i> }</b>
<b class="nc"><i>185</i> return new ParserResult(bibItems);</b>
<i>186</i> }
<i>187</i>
<i>188</i> private void parseBookArticle(PubmedBookArticle currentArticle, List<BibEntry> bibItems) {
<b class="nc"><i>189</i> Map<String, String> fields = new HashMap<>();</b>
<b class="nc"><i>190</i> if (currentArticle.getBookDocument() != null) {</b>
<b class="nc"><i>191</i> BookDocument bookDocument = currentArticle.getBookDocument();</b>
<b class="nc"><i>192</i> fields.put(FieldName.PMID, bookDocument.getPMID().getContent());</b>
<b class="nc"><i>193</i> if (bookDocument.getDateRevised() != null) {</b>
<b class="nc"><i>194</i> DateRevised dateRevised = bookDocument.getDateRevised();</b>
<b class="nc"><i>195</i> addDateRevised(fields, dateRevised);</b>
<i>196</i> }
<b class="nc"><i>197</i> if (bookDocument.getAbstract() != null) {</b>
<b class="nc"><i>198</i> Abstract abs = bookDocument.getAbstract();</b>
<b class="nc"><i>199</i> addAbstract(fields, abs);</b>
<i>200</i> }
<b class="nc"><i>201</i> if (bookDocument.getPagination() != null) {</b>
<b class="nc"><i>202</i> Pagination pagination = bookDocument.getPagination();</b>
<b class="nc"><i>203</i> addPagination(fields, pagination);</b>
<i>204</i> }
<b class="nc"><i>205</i> if (bookDocument.getSections() != null) {</b>
<b class="nc"><i>206</i> ArrayList<String> result = new ArrayList<>();</b>
<b class="nc"><i>207</i> Sections sections = bookDocument.getSections();</b>
<b class="nc"><i>208</i> for (Section section : sections.getSection()) {</b>
<b class="nc"><i>209</i> for (Serializable content : section.getSectionTitle().getContent()) {</b>
<b class="nc"><i>210</i> if (content instanceof String) {</b>
<b class="nc"><i>211</i> result.add((String) content);</b>
<i>212</i> }
<b class="nc"><i>213</i> }</b>
<b class="nc"><i>214</i> }</b>
<b class="nc"><i>215</i> fields.put("sections", join(result, "; "));</b>
<i>216</i> }
<b class="nc"><i>217</i> if (bookDocument.getKeywordList() != null) {</b>
<b class="nc"><i>218</i> addKeyWords(fields, bookDocument.getKeywordList());</b>
<i>219</i> }
<b class="nc"><i>220</i> if (bookDocument.getContributionDate() != null) {</b>
<b class="nc"><i>221</i> addContributionDate(fields, bookDocument.getContributionDate());</b>
<i>222</i> }
<b class="nc"><i>223</i> if (bookDocument.getPublicationType() != null) {</b>
<b class="nc"><i>224</i> List<String> result = new ArrayList<>();</b>
<b class="nc"><i>225</i> for (PublicationType type : bookDocument.getPublicationType()) {</b>
<b class="nc"><i>226</i> if (type.getContent() != null) {</b>
<b class="nc"><i>227</i> result.add(type.getContent());</b>
<i>228</i> }
<b class="nc"><i>229</i> }</b>
<b class="nc"><i>230</i> fields.put("pubtype", join(result, ", "));</b>
<i>231</i> }
<b class="nc"><i>232</i> if (bookDocument.getArticleTitle() != null) {</b>
<b class="nc"><i>233</i> ArticleTitle articleTitle = bookDocument.getArticleTitle();</b>
<b class="nc"><i>234</i> ArrayList<String> titles = new ArrayList<>();</b>
<b class="nc"><i>235</i> for (Serializable content : articleTitle.getContent()) {</b>
<b class="nc"><i>236</i> if (content instanceof String) {</b>
<b class="nc"><i>237</i> titles.add((String) content);</b>
<i>238</i> }
<b class="nc"><i>239</i> }</b>
<b class="nc"><i>240</i> fields.put("article", join(titles, ", "));</b>
<i>241</i> }
<b class="nc"><i>242</i> if (bookDocument.getBook() != null) {</b>
<b class="nc"><i>243</i> addBookInformation(fields, bookDocument.getBook());</b>
<i>244</i> }
<i>245</i> }
<i>246</i>
<b class="nc"><i>247</i> if (currentArticle.getPubmedBookData() != null) {</b>
<b class="nc"><i>248</i> PubmedBookData bookData = currentArticle.getPubmedBookData();</b>
<b class="nc"><i>249</i> putIfValueNotNull(fields, "pubstatus", bookData.getPublicationStatus());</b>
<i>250</i> }
<i>251</i>
<b class="nc"><i>252</i> BibEntry entry = new BibEntry("article");</b>
<b class="nc"><i>253</i> entry.setField(fields);</b>
<i>254</i>
<b class="nc"><i>255</i> bibItems.add(entry);</b>
<b class="nc"><i>256</i> }</b>
<i>257</i>
<i>258</i> private void addBookInformation(Map<String, String> fields, Book book) {
<b class="nc"><i>259</i> if (book.getPublisher() != null) {</b>
<b class="nc"><i>260</i> Publisher publisher = book.getPublisher();</b>
<b class="nc"><i>261</i> putIfValueNotNull(fields, "publocation", publisher.getPublisherLocation());</b>
<b class="nc"><i>262</i> putStringFromSerializableList(fields, FieldName.PUBLISHER, publisher.getPublisherName().getContent());</b>
<i>263</i> }
<b class="nc"><i>264</i> if (book.getBookTitle() != null) {</b>
<b class="nc"><i>265</i> BookTitle title = book.getBookTitle();</b>
<b class="nc"><i>266</i> putStringFromSerializableList(fields, FieldName.TITLE, title.getContent());</b>
<i>267</i> }
<b class="nc"><i>268</i> if (book.getPubDate() != null) {</b>
<b class="nc"><i>269</i> addPubDate(fields, book.getPubDate());</b>
<i>270</i> }
<b class="nc"><i>271</i> if (book.getAuthorList() != null) {</b>
<b class="nc"><i>272</i> List<AuthorList> authorLists = book.getAuthorList();</b>
<i>273</i> //authorLists size should be one
<b class="nc"><i>274</i> if (authorLists.size() == 1) {</b>
<b class="nc"><i>275</i> for (AuthorList authorList : authorLists) {</b>
<b class="nc"><i>276</i> handleAuthors(fields, authorList);</b>
<b class="nc"><i>277</i> }</b>
<i>278</i> } else {
<b class="nc"><i>279</i> LOGGER.info(String.format("Size of authorlist was %s", authorLists.size()));</b>
<i>280</i> }
<i>281</i> }
<i>282</i>
<b class="nc"><i>283</i> putIfValueNotNull(fields, FieldName.VOLUME, book.getVolume());</b>
<b class="nc"><i>284</i> putIfValueNotNull(fields, FieldName.EDITION, book.getEdition());</b>
<b class="nc"><i>285</i> putIfValueNotNull(fields, "medium", book.getMedium());</b>
<b class="nc"><i>286</i> putIfValueNotNull(fields, "reportnumber", book.getReportNumber());</b>
<i>287</i>
<b class="nc"><i>288</i> if (book.getELocationID() != null) {</b>
<b class="nc"><i>289</i> for (ELocationID id : book.getELocationID()) {</b>
<b class="nc"><i>290</i> addElocationID(fields, id);</b>
<b class="nc"><i>291</i> }</b>
<i>292</i> }
<b class="nc"><i>293</i> if (book.getIsbn() != null) {</b>
<b class="nc"><i>294</i> fields.put(FieldName.ISBN, join(book.getIsbn(), ", "));</b>
<i>295</i> }
<b class="nc"><i>296</i> }</b>
<i>297</i>
<i>298</i> private void putStringFromSerializableList(Map<String, String> fields, String medlineKey,
<i>299</i> List<Serializable> contentList) {
<b class="nc"><i>300</i> StringBuilder result = new StringBuilder();</b>
<b class="nc"><i>301</i> for (Serializable content : contentList) {</b>
<b class="nc"><i>302</i> if (content instanceof String) {</b>
<b class="nc"><i>303</i> result.append((String) content);</b>
<i>304</i> }
<b class="nc"><i>305</i> }</b>
<b class="nc"><i>306</i> if (result.length() > 0) {</b>
<b class="nc"><i>307</i> fields.put(medlineKey, result.toString());</b>
<i>308</i> }
<b class="nc"><i>309</i> }</b>
<i>310</i>
<i>311</i> private void addContributionDate(Map<String, String> fields, ContributionDate contributionDate) {
<b class="nc"><i>312</i> if ((contributionDate.getDay() != null) && (contributionDate.getMonth() != null)</b>
<b class="nc"><i>313</i> && (contributionDate.getYear() != null)) {</b>
<b class="nc"><i>314</i> String result = convertToDateFormat(contributionDate.getYear(), contributionDate.getMonth(),</b>
<b class="nc"><i>315</i> contributionDate.getDay());</b>
<b class="nc"><i>316</i> fields.put("contribution", result);</b>
<i>317</i> }
<b class="nc"><i>318</i> }</b>
<i>319</i>
<i>320</i> private String convertToDateFormat(String year, String month, String day) {
<b class="nc"><i>321</i> return String.format("%s-%s-%s", year, month, day);</b>
<i>322</i> }
<i>323</i>
<i>324</i> private void parseArticle(PubmedArticle article, List<BibEntry> bibItems) {
<b class="nc"><i>325</i> Map<String, String> fields = new HashMap<>();</b>
<i>326</i>
<b class="nc"><i>327</i> if (article.getPubmedData() != null) {</b>
<b class="nc"><i>328</i> if (article.getMedlineCitation().getDateRevised() != null) {</b>
<b class="nc"><i>329</i> DateRevised dateRevised = article.getMedlineCitation().getDateRevised();</b>
<b class="nc"><i>330</i> addDateRevised(fields, dateRevised);</b>
<b class="nc"><i>331</i> putIfValueNotNull(fields, "pubstatus", article.getPubmedData().getPublicationStatus());</b>
<b class="nc"><i>332</i> if (article.getPubmedData().getArticleIdList() != null) {</b>
<b class="nc"><i>333</i> ArticleIdList articleIdList = article.getPubmedData().getArticleIdList();</b>
<b class="nc"><i>334</i> addArticleIdList(fields, articleIdList);</b>
<i>335</i> }
<i>336</i> }
<i>337</i> }
<b class="nc"><i>338</i> if (article.getMedlineCitation() != null) {</b>
<b class="nc"><i>339</i> MedlineCitation medlineCitation = article.getMedlineCitation();</b>
<i>340</i>
<b class="nc"><i>341</i> fields.put("status", medlineCitation.getStatus());</b>
<b class="nc"><i>342</i> DateCreated dateCreated = medlineCitation.getDateCreated();</b>
<b class="nc"><i>343</i> fields.put("created",</b>
<b class="nc"><i>344</i> convertToDateFormat(dateCreated.getYear(), dateCreated.getMonth(), dateCreated.getDay()));</b>
<b class="nc"><i>345</i> fields.put("pubmodel", medlineCitation.getArticle().getPubModel());</b>
<i>346</i>
<b class="nc"><i>347</i> if (medlineCitation.getDateCompleted() != null) {</b>
<b class="nc"><i>348</i> DateCompleted dateCompleted = medlineCitation.getDateCompleted();</b>
<b class="nc"><i>349</i> fields.put("completed",</b>
<b class="nc"><i>350</i> convertToDateFormat(dateCompleted.getYear(), dateCompleted.getMonth(), dateCompleted.getDay()));</b>
<i>351</i> }
<i>352</i>
<b class="nc"><i>353</i> fields.put(FieldName.PMID, medlineCitation.getPMID().getContent());</b>
<b class="nc"><i>354</i> fields.put(FieldName.OWNER, medlineCitation.getOwner());</b>
<i>355</i>
<b class="nc"><i>356</i> addArticleInformation(fields, medlineCitation.getArticle().getContent());</b>
<i>357</i>
<b class="nc"><i>358</i> MedlineJournalInfo medlineJournalInfo = medlineCitation.getMedlineJournalInfo();</b>
<b class="nc"><i>359</i> putIfValueNotNull(fields, "country", medlineJournalInfo.getCountry());</b>
<b class="nc"><i>360</i> putIfValueNotNull(fields, "journal-abbreviation", medlineJournalInfo.getMedlineTA());</b>
<b class="nc"><i>361</i> putIfValueNotNull(fields, "nlm-id", medlineJournalInfo.getNlmUniqueID());</b>
<b class="nc"><i>362</i> putIfValueNotNull(fields, "issn-linking", medlineJournalInfo.getISSNLinking());</b>
<b class="nc"><i>363</i> if (medlineCitation.getChemicalList() != null) {</b>
<b class="nc"><i>364</i> if (medlineCitation.getChemicalList().getChemical() != null) {</b>
<b class="nc"><i>365</i> addChemicals(fields, medlineCitation.getChemicalList().getChemical());</b>
<i>366</i> }
<i>367</i> }
<b class="nc"><i>368</i> if (medlineCitation.getCitationSubset() != null) {</b>
<b class="nc"><i>369</i> fields.put("citation-subset", join(medlineCitation.getCitationSubset(), ", "));</b>
<i>370</i> }
<b class="nc"><i>371</i> if (medlineCitation.getGeneSymbolList() != null) {</b>
<b class="nc"><i>372</i> addGeneSymbols(fields, medlineCitation.getGeneSymbolList());</b>
<i>373</i> }
<b class="nc"><i>374</i> if (medlineCitation.getMeshHeadingList() != null) {</b>
<b class="nc"><i>375</i> addMeashHeading(fields, medlineCitation.getMeshHeadingList());</b>
<i>376</i> }
<b class="nc"><i>377</i> putIfValueNotNull(fields, "references", medlineCitation.getNumberOfReferences());</b>
<b class="nc"><i>378</i> if (medlineCitation.getPersonalNameSubjectList() != null) {</b>
<b class="nc"><i>379</i> addPersonalNames(fields, medlineCitation.getPersonalNameSubjectList());</b>
<i>380</i> }
<b class="nc"><i>381</i> if (medlineCitation.getOtherID() != null) {</b>
<b class="nc"><i>382</i> addOtherId(fields, medlineCitation.getOtherID());</b>
<i>383</i> }
<b class="nc"><i>384</i> if (medlineCitation.getKeywordList() != null) {</b>
<b class="nc"><i>385</i> addKeyWords(fields, medlineCitation.getKeywordList());</b>
<i>386</i> }
<b class="nc"><i>387</i> if (medlineCitation.getSpaceFlightMission() != null) {</b>
<b class="nc"><i>388</i> fields.put("space-flight-mission", join(medlineCitation.getSpaceFlightMission(), ", "));</b>
<i>389</i> }
<b class="nc"><i>390</i> if (medlineCitation.getInvestigatorList() != null) {</b>
<b class="nc"><i>391</i> addInvestigators(fields, medlineCitation.getInvestigatorList());</b>
<i>392</i> }
<b class="nc"><i>393</i> if (medlineCitation.getGeneralNote() != null) {</b>
<b class="nc"><i>394</i> addNotes(fields, medlineCitation.getGeneralNote());</b>
<i>395</i> }
<i>396</i> }
<i>397</i>
<b class="nc"><i>398</i> BibEntry entry = new BibEntry("article");</b>
<b class="nc"><i>399</i> entry.setField(fields);</b>
<i>400</i>
<b class="nc"><i>401</i> bibItems.add(entry);</b>
<b class="nc"><i>402</i> }</b>
<i>403</i>
<i>404</i> private void addArticleIdList(Map<String, String> fields, ArticleIdList articleIdList) {
<b class="nc"><i>405</i> for (ArticleId id : articleIdList.getArticleId()) {</b>
<b class="nc"><i>406</i> if (id.getIdType() != null) {</b>
<b class="nc"><i>407</i> if ("pubmed".equals(id.getIdType())) {</b>
<b class="nc"><i>408</i> fields.put("pmid", id.getContent());</b>
<i>409</i> } else {
<b class="nc"><i>410</i> fields.put(id.getIdType(), id.getContent());</b>
<i>411</i> }
<i>412</i> }
<b class="nc"><i>413</i> }</b>
<b class="nc"><i>414</i> }</b>
<i>415</i>
<i>416</i> private void addNotes(Map<String, String> fields, List<GeneralNote> generalNote) {
<b class="nc"><i>417</i> List<String> notes = new ArrayList<>();</b>
<b class="nc"><i>418</i> for (GeneralNote note : generalNote) {</b>
<b class="nc"><i>419</i> if (note != null) {</b>
<b class="nc"><i>420</i> notes.add(note.getContent());</b>
<i>421</i> }
<b class="nc"><i>422</i> }</b>
<b class="nc"><i>423</i> fields.put(FieldName.NOTE, join(notes, ", "));</b>
<b class="nc"><i>424</i> }</b>
<i>425</i>
<i>426</i> private void addInvestigators(Map<String, String> fields, InvestigatorList investigatorList) {
<b class="nc"><i>427</i> List<String> investigatorNames = new ArrayList<>();</b>
<b class="nc"><i>428</i> List<String> affiliationInfos = new ArrayList<>();</b>
<b class="nc"><i>429</i> String name = "";</b>
<i>430</i> // add the investigators like the authors
<b class="nc"><i>431</i> if (investigatorList.getInvestigator() != null) {</b>
<b class="nc"><i>432</i> List<Investigator> investigators = investigatorList.getInvestigator();</b>
<b class="nc"><i>433</i> for (Investigator investigator : investigators) {</b>
<b class="nc"><i>434</i> name = investigator.getLastName();</b>
<b class="nc"><i>435</i> if (investigator.getForeName() != null) {</b>
<b class="nc"><i>436</i> name += ", " + investigator.getForeName();</b>
<i>437</i> }
<b class="nc"><i>438</i> investigatorNames.add(name);</b>
<i>439</i>
<i>440</i> //now add the affiliation info
<b class="nc"><i>441</i> if (investigator.getAffiliationInfo() != null) {</b>
<b class="nc"><i>442</i> for (AffiliationInfo info : investigator.getAffiliationInfo()) {</b>
<b class="nc"><i>443</i> for (Serializable affiliation : info.getAffiliation().getContent()) {</b>
<b class="nc"><i>444</i> if (affiliation instanceof String) {</b>
<b class="nc"><i>445</i> affiliationInfos.add((String) affiliation);</b>
<i>446</i> }
<b class="nc"><i>447</i> }</b>
<b class="nc"><i>448</i> }</b>
<b class="nc"><i>449</i> fields.put("affiliation", join(affiliationInfos, ", "));</b>
<i>450</i> }
<b class="nc"><i>451</i> }</b>
<b class="nc"><i>452</i> fields.put("investigator", join(investigatorNames, " and "));</b>
<i>453</i> }
<b class="nc"><i>454</i> }</b>
<i>455</i>
<i>456</i> private void addKeyWords(Map<String, String> fields, List<KeywordList> allKeywordLists) {
<b class="nc"><i>457</i> List<String> keywordStrings = new ArrayList<>();</b>
<i>458</i> //add keywords to the list
<b class="nc"><i>459</i> for (KeywordList keywordList : allKeywordLists) {</b>
<b class="nc"><i>460</i> for (Keyword keyword : keywordList.getKeyword()) {</b>
<b class="nc"><i>461</i> for (Serializable content : keyword.getContent()) {</b>
<b class="nc"><i>462</i> if (content instanceof String) {</b>
<b class="nc"><i>463</i> keywordStrings.add((String) content);</b>
<i>464</i> }
<b class="nc"><i>465</i> }</b>
<b class="nc"><i>466</i> }</b>
<b class="nc"><i>467</i> }</b>
<i>468</i> //Check whether MeshHeadingList exist or not
<b class="nc"><i>469</i> if (fields.get(FieldName.KEYWORDS) == null) {</b>
<b class="nc"><i>470</i> fields.put(FieldName.KEYWORDS, join(keywordStrings, KEYWORD_SEPARATOR));</b>
<i>471</i> } else {
<b class="nc"><i>472</i> if (keywordStrings.size() > 0) {</b>
<i>473</i> //if it exists, combine the MeshHeading with the keywords
<b class="nc"><i>474</i> String result = join(keywordStrings, "; ");</b>
<b class="nc"><i>475</i> result = fields.get(FieldName.KEYWORDS) + KEYWORD_SEPARATOR + result;</b>
<b class="nc"><i>476</i> fields.put(FieldName.KEYWORDS, result);</b>
<i>477</i> }
<i>478</i> }
<b class="nc"><i>479</i> }</b>
<i>480</i>
<i>481</i> private void addOtherId(Map<String, String> fields, List<OtherID> otherID) {
<b class="nc"><i>482</i> for (OtherID id : otherID) {</b>
<b class="nc"><i>483</i> if ((id.getSource() != null) && (id.getContent() != null)) {</b>
<b class="nc"><i>484</i> fields.put(id.getSource(), id.getContent());</b>
<i>485</i> }
<b class="nc"><i>486</i> }</b>
<b class="nc"><i>487</i> }</b>
<i>488</i>
<i>489</i> private void addPersonalNames(Map<String, String> fields, PersonalNameSubjectList personalNameSubjectList) {
<b class="nc"><i>490</i> if (fields.get(FieldName.AUTHOR) == null) {</b>
<i>491</i> //if no authors appear, then add the personal names as authors
<b class="nc"><i>492</i> List<String> personalNames = new ArrayList<>();</b>
<b class="nc"><i>493</i> if (personalNameSubjectList.getPersonalNameSubject() != null) {</b>
<b class="nc"><i>494</i> List<PersonalNameSubject> personalNameSubject = personalNameSubjectList.getPersonalNameSubject();</b>
<b class="nc"><i>495</i> for (PersonalNameSubject personalName : personalNameSubject) {</b>
<b class="nc"><i>496</i> String name = personalName.getLastName();</b>
<b class="nc"><i>497</i> if (personalName.getForeName() != null) {</b>
<b class="nc"><i>498</i> name += ", " + personalName.getForeName().toString();</b>
<i>499</i> }
<b class="nc"><i>500</i> personalNames.add(name);</b>
<b class="nc"><i>501</i> }</b>
<b class="nc"><i>502</i> fields.put(FieldName.AUTHOR, join(personalNames, " and "));</b>
<i>503</i> }
<i>504</i> }
<b class="nc"><i>505</i> }</b>
<i>506</i>
<i>507</i> private void addMeashHeading(Map<String, String> fields, MeshHeadingList meshHeadingList) {
<b class="nc"><i>508</i> ArrayList<String> keywords = new ArrayList<>();</b>
<b class="nc"><i>509</i> for (MeshHeading keyword : meshHeadingList.getMeshHeading()) {</b>
<b class="nc"><i>510</i> String result = keyword.getDescriptorName().getContent();</b>
<b class="nc"><i>511</i> if (keyword.getQualifierName() != null) {</b>
<b class="nc"><i>512</i> for (QualifierName qualifier : keyword.getQualifierName()) {</b>
<b class="nc"><i>513</i> result += ", " + qualifier.getContent();</b>
<b class="nc"><i>514</i> }</b>
<i>515</i> }
<b class="nc"><i>516</i> keywords.add(result);</b>
<b class="nc"><i>517</i> }</b>
<b class="nc"><i>518</i> fields.put(FieldName.KEYWORDS, join(keywords, KEYWORD_SEPARATOR));</b>
<b class="nc"><i>519</i> }</b>
<i>520</i>
<i>521</i> private void addGeneSymbols(Map<String, String> fields, GeneSymbolList geneSymbolList) {
<b class="nc"><i>522</i> List<String> geneSymbols = geneSymbolList.getGeneSymbol();</b>
<b class="nc"><i>523</i> fields.put("gene-symbols", join(geneSymbols, ", "));</b>
<b class="nc"><i>524</i> }</b>
<i>525</i>
<i>526</i> private void addChemicals(Map<String, String> fields, List<Chemical> chemicals) {
<b class="nc"><i>527</i> List<String> chemicalNames = new ArrayList<>();</b>
<b class="nc"><i>528</i> for (Chemical chemical : chemicals) {</b>
<b class="nc"><i>529</i> if (chemical != null) {</b>
<b class="nc"><i>530</i> chemicalNames.add(chemical.getNameOfSubstance().getContent());</b>
<i>531</i> }
<b class="nc"><i>532</i> }</b>
<b class="nc"><i>533</i> fields.put("chemicals", join(chemicalNames, ", "));</b>
<b class="nc"><i>534</i> }</b>
<i>535</i>
<i>536</i> private void addArticleInformation(Map<String, String> fields, List<Object> content) {
<b class="nc"><i>537</i> for (Object object : content) {</b>
<b class="nc"><i>538</i> if (object instanceof Journal) {</b>
<b class="nc"><i>539</i> Journal journal = (Journal) object;</b>
<b class="nc"><i>540</i> putIfValueNotNull(fields, FieldName.JOURNAL, journal.getTitle());</b>
<i>541</i>
<b class="nc"><i>542</i> ISSN issn = journal.getISSN();</b>
<b class="nc"><i>543</i> if (issn != null) {</b>
<b class="nc"><i>544</i> putIfValueNotNull(fields, FieldName.ISSN, issn.getContent());</b>
<i>545</i> }
<i>546</i>
<b class="nc"><i>547</i> JournalIssue journalIssue = journal.getJournalIssue();</b>
<b class="nc"><i>548</i> putIfValueNotNull(fields, FieldName.VOLUME, journalIssue.getVolume());</b>
<b class="nc"><i>549</i> putIfValueNotNull(fields, FieldName.ISSUE, journalIssue.getIssue());</b>
<i>550</i>
<b class="nc"><i>551</i> addPubDate(fields, journalIssue.getPubDate());</b>
<b class="nc"><i>552</i> } else if (object instanceof ArticleTitle) {</b>
<b class="nc"><i>553</i> ArticleTitle articleTitle = (ArticleTitle) object;</b>
<b class="nc"><i>554</i> fields.put(FieldName.TITLE, StringUtil.stripBrackets(articleTitle.getContent().toString()));</b>
<b class="nc"><i>555</i> } else if (object instanceof Pagination) {</b>
<b class="nc"><i>556</i> Pagination pagination = (Pagination) object;</b>
<b class="nc"><i>557</i> addPagination(fields, pagination);</b>
<b class="nc"><i>558</i> } else if (object instanceof ELocationID) {</b>
<b class="nc"><i>559</i> ELocationID eLocationID = (ELocationID) object;</b>
<b class="nc"><i>560</i> addElocationID(fields, eLocationID);</b>
<b class="nc"><i>561</i> } else if (object instanceof Abstract) {</b>
<b class="nc"><i>562</i> Abstract abs = (Abstract) object;</b>
<b class="nc"><i>563</i> addAbstract(fields, abs);</b>
<b class="nc"><i>564</i> } else if (object instanceof AuthorList) {</b>
<b class="nc"><i>565</i> AuthorList authors = (AuthorList) object;</b>
<b class="nc"><i>566</i> handleAuthors(fields, authors);</b>
<i>567</i> }
<b class="nc"><i>568</i> }</b>
<b class="nc"><i>569</i> }</b>
<i>570</i>
<i>571</i> private void addElocationID(Map<String, String> fields, ELocationID eLocationID) {
<b class="nc"><i>572</i> if (FieldName.DOI.equals(eLocationID.getEIdType())) {</b>
<b class="nc"><i>573</i> fields.put(FieldName.DOI, eLocationID.getContent());</b>
<i>574</i> }
<b class="nc"><i>575</i> if ("pii".equals(eLocationID.getEIdType())) {</b>
<b class="nc"><i>576</i> fields.put("pii", eLocationID.getContent());</b>
<i>577</i> }
<b class="nc"><i>578</i> }</b>
<i>579</i>
<i>580</i> private void addPubDate(Map<String, String> fields, PubDate pubDate) {
<b class="nc"><i>581</i> if (pubDate.getYear() == null) {</b>
<i>582</i> //if year of the pubdate is null, the medlineDate shouldn't be null
<b class="nc"><i>583</i> fields.put(FieldName.YEAR, extractYear(pubDate.getMedlineDate()));</b>
<i>584</i> } else {
<b class="nc"><i>585</i> fields.put(FieldName.YEAR, pubDate.getYear());</b>
<b class="nc"><i>586</i> if (pubDate.getMonth() != null) {</b>
<b class="nc"><i>587</i> fields.put(FieldName.MONTH, pubDate.getMonth());</b>
<b class="nc"><i>588</i> } else if (pubDate.getSeason() != null) {</b>
<b class="nc"><i>589</i> fields.put("season", pubDate.getSeason());</b>
<i>590</i> }
<i>591</i> }
<b class="nc"><i>592</i> }</b>
<i>593</i>
<i>594</i> private void addAbstract(Map<String, String> fields, Abstract abs) {
<b class="nc"><i>595</i> putIfValueNotNull(fields, "copyright", abs.getCopyrightInformation());</b>
<b class="nc"><i>596</i> List<String> abstractText = new ArrayList<>();</b>
<b class="nc"><i>597</i> for (AbstractText text : abs.getAbstractText()) {</b>
<b class="nc"><i>598</i> for (Serializable textContent : text.getContent()) {</b>
<b class="nc"><i>599</i> if (textContent instanceof String) {</b>
<b class="nc"><i>600</i> abstractText.add((String) textContent);</b>
<i>601</i> }
<b class="nc"><i>602</i> }</b>
<b class="nc"><i>603</i> }</b>
<b class="nc"><i>604</i> fields.put(FieldName.ABSTRACT, join(abstractText, " "));</b>
<b class="nc"><i>605</i> }</b>
<i>606</i>
<i>607</i> private void addPagination(Map<String, String> fields, Pagination pagination) {
<b class="nc"><i>608</i> String startPage = "";</b>
<b class="nc"><i>609</i> String endPage = "";</b>
<b class="nc"><i>610</i> for (JAXBElement<String> element : pagination.getContent()) {</b>
<b class="nc"><i>611</i> if ("MedlinePgn".equals(element.getName().getLocalPart())) {</b>
<b class="nc"><i>612</i> putIfValueNotNull(fields, FieldName.PAGES, fixPageRange(element.getValue()));</b>
<b class="nc"><i>613</i> } else if ("StartPage".equals(element.getName().getLocalPart())) {</b>
<i>614</i> //it could happen, that the article has only a start page
<b class="nc"><i>615</i> startPage = element.getValue() + endPage;</b>
<b class="nc"><i>616</i> putIfValueNotNull(fields, FieldName.PAGES, startPage);</b>
<b class="nc"><i>617</i> } else if ("EndPage".equals(element.getName().getLocalPart())) {</b>
<b class="nc"><i>618</i> endPage = element.getValue();</b>
<i>619</i> //but it should not happen, that a endpage appears without startpage
<b class="nc"><i>620</i> fields.put(FieldName.PAGES, fixPageRange(startPage + "-" + endPage));</b>
<i>621</i> }
<b class="nc"><i>622</i> }</b>
<b class="nc"><i>623</i> }</b>
<i>624</i>
<i>625</i> private String extractYear(String medlineDate) {
<i>626</i> //The year of the medlineDate should be the first 4 digits
<b class="nc"><i>627</i> return medlineDate.substring(0, 4);</b>
<i>628</i> }
<i>629</i>
<i>630</i> private void handleAuthors(Map<String, String> fields, AuthorList authors) {
<b class="nc"><i>631</i> List<String> authorNames = new ArrayList<>();</b>
<b class="nc"><i>632</i> for (Author author : authors.getAuthor()) {</b>
<b class="nc"><i>633</i> if (author.getCollectiveName() != null) {</b>
<b class="nc"><i>634</i> Text collectiveNames = author.getCollectiveName();</b>
<b class="nc"><i>635</i> for (Serializable content : collectiveNames.getContent()) {</b>
<b class="nc"><i>636</i> if (content instanceof String) {</b>
<b class="nc"><i>637</i> authorNames.add((String) content);</b>
<i>638</i> }
<b class="nc"><i>639</i> }</b>
<b class="nc"><i>640</i> } else {</b>
<b class="nc"><i>641</i> String authorName = author.getLastName();</b>
<b class="nc"><i>642</i> if (author.getForeName() != null) {</b>
<b class="nc"><i>643</i> authorName += ", " + author.getForeName();</b>
<i>644</i> }
<b class="nc"><i>645</i> authorNames.add(authorName);</b>
<i>646</i> }
<b class="nc"><i>647</i> }</b>
<b class="nc"><i>648</i> fields.put(FieldName.AUTHOR, join(authorNames, " and "));</b>
<b class="nc"><i>649</i> }</b>
<i>650</i>
<i>651</i> private void addDateRevised(Map<String, String> fields, DateRevised dateRevised) {
<b class="nc"><i>652</i> if ((dateRevised.getDay() != null) && (dateRevised.getMonth() != null) && (dateRevised.getYear() != null)) {</b>
<b class="nc"><i>653</i> fields.put("revised",</b>
<b class="nc"><i>654</i> convertToDateFormat(dateRevised.getYear(), dateRevised.getMonth(), dateRevised.getDay()));</b>
<i>655</i> }
<b class="nc"><i>656</i> }</b>
<i>657</i>
<i>658</i> private void putIfValueNotNull(Map<String, String> fields, String medlineKey, String value) {
<b class="nc"><i>659</i> if (value != null) {</b>
<b class="nc"><i>660</i> fields.put(medlineKey, value);</b>
<i>661</i> }
<b class="nc"><i>662</i> }</b>
<i>663</i>
<i>664</i> /**
<i>665</i> * Convert medline page ranges from short form to full form.
<i>666</i> * Medline reports page ranges in a shorthand format.
<i>667</i> * The last page is reported using only the digits which
<i>668</i> * differ from the first page.
<i>669</i> * i.e. 12345-51 refers to the actual range 12345-12351
<i>670</i> */
<i>671</i> private String fixPageRange(String pageRange) {
<b class="nc"><i>672</i> int minusPos = pageRange.indexOf('-');</b>
<b class="nc"><i>673</i> if (minusPos < 0) {</b>
<b class="nc"><i>674</i> return pageRange;</b>
<i>675</i> }
<b class="nc"><i>676</i> String startPage = pageRange.substring(0, minusPos).trim();</b>
<b class="nc"><i>677</i> String endPage = pageRange.substring(minusPos + 1).trim();</b>
<b class="nc"><i>678</i> int lengthOfEndPage = endPage.length();</b>
<b class="nc"><i>679</i> int lengthOfStartPage = startPage.length();</b>
<b class="nc"><i>680</i> if (lengthOfEndPage < lengthOfStartPage) {</b>
<b class="nc"><i>681</i> endPage = startPage.substring(0, lengthOfStartPage - lengthOfEndPage) + endPage;</b>
<i>682</i> }
<b class="nc"><i>683</i> return startPage + "--" + endPage;</b>
<i>684</i> }
<i>685</i>
<i>686</i> @Override
<i>687</i> public List<BibEntry> parseEntries(InputStream inputStream) throws ParseException {
<i>688</i> try {
<b class="nc"><i>689</i> return importDatabase(</b>
<b class="nc"><i>690</i> new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8))).getDatabase().getEntries();</b>
<i>691</i>
<b class="nc"><i>692</i> } catch (IOException e) {</b>
<b class="nc"><i>693</i> LOGGER.error(e.getLocalizedMessage(), e);</b>
<i>694</i> }
<b class="nc"><i>695</i> return Collections.emptyList();</b>
<i>696</i> }
<i>697</i> }
</div>
</div>
<div class="footer">
<div style="float:right;">generated on 2017-07-15 00:44</div>
</div>
</body>
</html>
|
JessicaDias/JabRef_ES2
|
ReportImportTests/net.sf.jabref.logic.importer.fileformat/.classes/MedlineImporter.html
|
HTML
|
mit
| 52,126 |
<!DOCTYPE html>
<!--[if lt IE 9]><html class="no-js lt-ie9" lang="en" dir="ltr"><![endif]-->
<!--[if gt IE 8]><!-->
<html class="no-js" lang="en" dir="ltr">
<!--<![endif]-->
<!-- Usage: /eic/site/ccc-rec.nsf/tpl-eng/template-1col.html?Open&id=3 (optional: ?Open&page=filename.html&id=x) -->
<!-- Created: ; Product Code: 536; Server: stratnotes2.ic.gc.ca -->
<head>
<!-- Title begins / Début du titre -->
<title>
TASI Technical Software Inc. -
Complete profile - Canadian Company Capabilities - Industries and Business - Industry Canada
</title>
<!-- Title ends / Fin du titre -->
<!-- Meta-data begins / Début des métadonnées -->
<meta charset="utf-8" />
<meta name="dcterms.language" title="ISO639-2" content="eng" />
<meta name="dcterms.title" content="" />
<meta name="description" content="" />
<meta name="dcterms.description" content="" />
<meta name="dcterms.type" content="report, data set" />
<meta name="dcterms.subject" content="businesses, industry" />
<meta name="dcterms.subject" content="businesses, industry" />
<meta name="dcterms.issued" title="W3CDTF" content="" />
<meta name="dcterms.modified" title="W3CDTF" content="" />
<meta name="keywords" content="" />
<meta name="dcterms.creator" content="" />
<meta name="author" content="" />
<meta name="dcterms.created" title="W3CDTF" content="" />
<meta name="dcterms.publisher" content="" />
<meta name="dcterms.audience" title="icaudience" content="" />
<meta name="dcterms.spatial" title="ISO3166-1" content="" />
<meta name="dcterms.spatial" title="gcgeonames" content="" />
<meta name="dcterms.format" content="HTML" />
<meta name="dcterms.identifier" title="ICsiteProduct" content="536" />
<!-- EPI-11240 -->
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!-- MCG-202 -->
<meta content="width=device-width,initial-scale=1" name="viewport">
<!-- EPI-11567 -->
<meta name = "format-detection" content = "telephone=no">
<!-- EPI-12603 -->
<meta name="robots" content="noarchive">
<!-- EPI-11190 - Webtrends -->
<script>
var startTime = new Date();
startTime = startTime.getTime();
</script>
<!--[if gte IE 9 | !IE ]><!-->
<link href="/utils/scripts/_WET_4-0/apps/themes-dist/gcweb/assets/favicon.ico" rel="icon" type="image/x-icon">
<link rel="stylesheet" href="/utils/scripts/_WET_4-0/apps/themes-dist/gcweb/css/wet-boew.min.css">
<!--<![endif]-->
<link rel="stylesheet" href="/utils/scripts/_WET_4-0/apps/themes-dist/gcweb/css/theme.min.css">
<!--[if lt IE 9]>
<link href="/utils/scripts/_WET_4-0/apps/themes-dist/gcweb/assets/favicon.ico" rel="shortcut icon" />
<link rel="stylesheet" href="/utils/scripts/_WET_4-0/apps/themes-dist/gcweb/css/ie8-wet-boew.min.css" />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script src="/utils/scripts/_WET_4-0/apps/themes-dist/gcweb/js/ie8-wet-boew.min.js"></script>
<![endif]-->
<!--[if lte IE 9]>
<![endif]-->
<noscript><link rel="stylesheet" href="/utils/scripts/_WET_4-0/apps/themes-dist/gcweb/css/noscript.min.css" /></noscript>
<!-- Google Tag Manager DO NOT REMOVE OR MODIFY - NE PAS SUPPRIMER OU MODIFIER -->
<script>dataLayer1 = [];</script>
<!-- End Google Tag Manager -->
<!-- EPI-11235 -->
<link rel="stylesheet" href="/eic/home.nsf/css/add_WET_4-0_Canada_Apps.css">
<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet">
<link href="/app/ccc/srch/css/print.css" media="print" rel="stylesheet" type="text/css" />
</head>
<body class="home" vocab="http://schema.org/" typeof="WebPage">
<!-- EPIC HEADER BEGIN -->
<!-- Google Tag Manager DO NOT REMOVE OR MODIFY - NE PAS SUPPRIMER OU MODIFIER -->
<noscript><iframe title="Google Tag Manager" src="//www.googletagmanager.com/ns.html?id=GTM-TLGQ9K" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer1'?'&l='+l:'';j.async=true;j.src='//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer1','GTM-TLGQ9K');</script>
<!-- End Google Tag Manager -->
<!-- EPI-12801 -->
<span typeof="Organization"><meta property="legalName" content="Department_of_Industry"></span>
<ul id="wb-tphp">
<li class="wb-slc">
<a class="wb-sl" href="#wb-cont">Skip to main content</a>
</li>
<li class="wb-slc visible-sm visible-md visible-lg">
<a class="wb-sl" href="#wb-info">Skip to "About this site"</a>
</li>
</ul>
<header role="banner">
<div id="wb-bnr" class="container">
<section id="wb-lng" class="visible-md visible-lg text-right">
<h2 class="wb-inv">Language selection</h2>
<div class="row">
<div class="col-md-12">
<ul class="list-inline mrgn-bttm-0">
<li><a href="nvgt.do?V_TOKEN=1492323181709&V_SEARCH.docsCount=3&V_DOCUMENT.docRank=45280&V_SEARCH.docsStart=45279&V_SEARCH.command=navigate&V_SEARCH.resultsJSP=/prfl.do&lang=fra&redirectUrl=/app/scr/imbs/ccc/rgstrtn/rgstr.sec?_flId?_flxKy=e1s1&estblmntNo=234567041301&profileId=61&_evId=bck'A=0&lang=eng&V_SEARCH.showStricts=false&prtl=1&_flId?_flId?_flxKy=e1s1" title="Français" lang="fr">Français</a></li>
</ul>
</div>
</div>
</section>
<div class="row">
<div class="brand col-xs-8 col-sm-9 col-md-6">
<a href="http://www.canada.ca/en/index.html"><object type="image/svg+xml" tabindex="-1" data="/utils/scripts/_WET_4-0/apps/themes-dist/gcweb/assets/sig-blk-en.svg"></object><span class="wb-inv"> Government of Canada</span></a>
</div>
<section class="wb-mb-links col-xs-4 col-sm-3 visible-sm visible-xs" id="wb-glb-mn">
<h2>Search and menus</h2>
<ul class="list-inline text-right chvrn">
<li><a href="#mb-pnl" title="Search and menus" aria-controls="mb-pnl" class="overlay-lnk" role="button"><span class="glyphicon glyphicon-search"><span class="glyphicon glyphicon-th-list"><span class="wb-inv">Search and menus</span></span></span></a></li>
</ul>
<div id="mb-pnl"></div>
</section>
<!-- Site Search Removed -->
</div>
</div>
<nav role="navigation" id="wb-sm" class="wb-menu visible-md visible-lg" data-trgt="mb-pnl" data-ajax-fetch="//cdn.canada.ca/gcweb-cdn-dev/sitemenu/sitemenu-en.html" typeof="SiteNavigationElement">
<h2 class="wb-inv">Topics menu</h2>
<div class="container nvbar">
<div class="row">
<ul class="list-inline menu">
<li><a href="https://www.canada.ca/en/services/jobs.html">Jobs</a></li>
<li><a href="http://www.cic.gc.ca/english/index.asp">Immigration</a></li>
<li><a href="https://travel.gc.ca/">Travel</a></li>
<li><a href="https://www.canada.ca/en/services/business.html">Business</a></li>
<li><a href="https://www.canada.ca/en/services/benefits.html">Benefits</a></li>
<li><a href="http://healthycanadians.gc.ca/index-eng.php">Health</a></li>
<li><a href="https://www.canada.ca/en/services/taxes.html">Taxes</a></li>
<li><a href="https://www.canada.ca/en/services.html">More services</a></li>
</ul>
</div>
</div>
</nav>
<!-- EPIC BODY BEGIN -->
<nav role="navigation" id="wb-bc" class="" property="breadcrumb">
<h2 class="wb-inv">You are here:</h2>
<div class="container">
<div class="row">
<ol class="breadcrumb">
<li><a href="/eic/site/icgc.nsf/eng/home" title="Home">Home</a></li>
<li><a href="/eic/site/icgc.nsf/eng/h_07063.html" title="Industries and Business">Industries and Business</a></li>
<li><a href="/eic/site/ccc-rec.nsf/tpl-eng/../eng/home" >Canadian Company Capabilities</a></li>
</ol>
</div>
</div>
</nav>
</header>
<main id="wb-cont" role="main" property="mainContentOfPage" class="container">
<!-- End Header -->
<!-- Begin Body -->
<!-- Begin Body Title -->
<!-- End Body Title -->
<!-- Begin Body Head -->
<!-- End Body Head -->
<!-- Begin Body Content -->
<br>
<!-- Complete Profile -->
<!-- Company Information above tabbed area-->
<input id="showMore" type="hidden" value='more'/>
<input id="showLess" type="hidden" value='less'/>
<h1 id="wb-cont">
Company profile - Canadian Company Capabilities
</h1>
<div class="profileInfo hidden-print">
<ul class="list-inline">
<li><a href="cccSrch.do?lang=eng&profileId=&prtl=1&key.hitsPerPage=25&searchPage=%252Fapp%252Fccc%252Fsrch%252FcccBscSrch.do%253Flang%253Deng%2526amp%253Bprtl%253D1%2526amp%253Btagid%253D&V_SEARCH.scopeCategory=CCC.Root&V_SEARCH.depth=1&V_SEARCH.showStricts=false&V_SEARCH.sortSpec=title+asc&rstBtn.x=" class="btn btn-link">New Search</a> |</li>
<li><form name="searchForm" method="post" action="/app/ccc/srch/bscSrch.do">
<input type="hidden" name="lang" value="eng" />
<input type="hidden" name="profileId" value="" />
<input type="hidden" name="prtl" value="1" />
<input type="hidden" name="searchPage" value="%2Fapp%2Fccc%2Fsrch%2FcccBscSrch.do%3Flang%3Deng%26amp%3Bprtl%3D1%26amp%3Btagid%3D" />
<input type="hidden" name="V_SEARCH.scopeCategory" value="CCC.Root" />
<input type="hidden" name="V_SEARCH.depth" value="1" />
<input type="hidden" name="V_SEARCH.showStricts" value="false" />
<input id="repeatSearchBtn" class="btn btn-link" type="submit" value="Return to search results" />
</form></li>
<li>| <a href="nvgt.do?V_SEARCH.docsStart=45278&V_DOCUMENT.docRank=45279&V_SEARCH.docsCount=3&lang=eng&prtl=1&sbPrtl=&profile=cmpltPrfl&V_TOKEN=1492323190854&V_SEARCH.command=navigate&V_SEARCH.resultsJSP=%2fprfl.do&estblmntNo=234567163467&profileId=&key.newSearchLabel=">Previous Company</a></li>
<li>| <a href="nvgt.do?V_SEARCH.docsStart=45280&V_DOCUMENT.docRank=45281&V_SEARCH.docsCount=3&lang=eng&prtl=1&sbPrtl=&profile=cmpltPrfl&V_TOKEN=1492323190854&V_SEARCH.command=navigate&V_SEARCH.resultsJSP=%2fprfl.do&estblmntNo=234567121526&profileId=&key.newSearchLabel=">Next Company</a></li>
</ul>
</div>
<details>
<summary>Third-Party Information Liability Disclaimer</summary>
<p>Some of the information on this Web page has been provided by external sources. The Government of Canada is not responsible for the accuracy, reliability or currency of the information supplied by external sources. Users wishing to rely upon this information should consult directly with the source of the information. Content provided by external sources is not subject to official languages, privacy and accessibility requirements.</p>
</details>
<h2>
TASI Technical Software Inc.
</h2>
<div class="row">
<div class="col-md-5">
<h2 class="h5 mrgn-bttm-0">Legal/Operating Name:</h2>
<p>TASI Technical Software Inc.</p>
<div class="mrgn-tp-md"></div>
<p class="mrgn-bttm-0" ><a href="http://www.tasitechnical.com"
target="_blank" title="Website URL">http://www.tasitechnical.com</a></p>
<p><a href="mailto:[email protected]" title="[email protected]">[email protected]</a></p>
</div>
<div class="col-md-4 mrgn-sm-sm">
<h2 class="h5 mrgn-bttm-0">Mailing Address:</h2>
<address class="mrgn-bttm-md">
149 Earl St<br/>
KINGSTON,
Ontario<br/>
K7L 2H3
<br/>
</address>
<h2 class="h5 mrgn-bttm-0">Location Address:</h2>
<address class="mrgn-bttm-md">
149 Earl St<br/>
KINGSTON,
Ontario<br/>
K7L 2H3
<br/>
</address>
<p class="mrgn-bttm-0"><abbr title="Telephone">Tel.</abbr>:
(416) 964-2108
</p>
<p class="mrgn-bttm-lg"><abbr title="Facsimile">Fax</abbr>:
(416) 960-9245</p>
</div>
<div class="col-md-3 mrgn-tp-md">
</div>
</div>
<div class="row mrgn-tp-md mrgn-bttm-md">
<div class="col-md-12">
<h2 class="wb-inv">Company Profile</h2>
<br> Produce and provide analytical solutions for areas of material science and applied physics. Areas include software tools for the characterisation of piezoelectric, electrostrictive and ferroelectric materials and X-ray methods.<br>
</div>
</div>
<!-- <div class="wb-tabs ignore-session update-hash wb-eqht-off print-active"> -->
<div class="wb-tabs ignore-session">
<div class="tabpanels">
<details id="details-panel1">
<summary>
Full profile
</summary>
<!-- Tab 1 -->
<h2 class="wb-invisible">
Full profile
</h2>
<!-- Contact Information -->
<h3 class="page-header">
Contact information
</h3>
<section class="container-fluid">
<div class="row mrgn-tp-lg">
<div class="col-md-3">
<strong>
Ron
Tasker
</strong></div>
</div>
<div class="row mrgn-lft-md">
<div class="col-md-5">
<strong>
Title:
</strong>
</div>
<div class="col-md-7">
<!--if client gender is not null or empty we use gender based job title-->
President
</div>
</div>
<div class="row mrgn-lft-md">
<div class="col-md-5">
<strong>
Telephone:
</strong>
</div>
<div class="col-md-7">
(416) 964-2108
</div>
</div>
<div class="row mrgn-lft-md">
<div class="col-md-5">
<strong>
Facsimile:
</strong>
</div>
<div class="col-md-7">
(416) 960-9245
</div>
</div>
<div class="row mrgn-lft-md">
<div class="col-md-5">
<strong>
Email:
</strong>
</div>
<div class="col-md-7">
[email protected]
</div>
</div>
</section>
<p class="mrgn-tp-lg text-right small hidden-print">
<a href="#wb-cont">top of page</a>
</p>
<!-- Company Description -->
<h3 class="page-header">
Company description
</h3>
<section class="container-fluid">
<div class="row">
<div class="col-md-5">
<strong>
Exporting:
</strong>
</div>
<div class="col-md-7">
Yes
</div>
</div>
<div class="row">
<div class="col-md-5">
<strong>
Primary Industry (NAICS):
</strong>
</div>
<div class="col-md-7">
511210 - Software Publishers
</div>
</div>
<div class="row">
<div class="col-md-5">
<strong>
Alternate Industries (NAICS):
</strong>
</div>
<div class="col-md-7">
541510 - Computer Systems Design and Related Services<br>
</div>
</div>
<div class="row">
<div class="col-md-5">
<strong>
Primary Business Activity:
</strong>
</div>
<div class="col-md-7">
Manufacturer / Processor / Producer
</div>
</div>
</section>
<!-- Products / Services / Licensing -->
<h3 class="page-header">
Product / Service / Licensing
</h3>
<section class="container-fluid">
<div class="row mrgn-bttm-md">
<div class="col-md-3">
<strong>
Product Name:
</strong>
</div>
<div class="col-md-9">
(PRAP) Piezoelectric Resonance Analysis Program<br>
</div>
</div>
<div class="row mrgn-bttm-md">
<div class="col-md-12">
Acquires and analyses electrical impedance spectra in frequency
<br>
of piezoelectric resonators. Resonance spectrum is analysed to
<br>
determine complex material properties.<br>
<br>
</div>
</div>
<div class="row mrgn-bttm-md">
<div class="col-md-3">
<strong>
Product Name:
</strong>
</div>
<div class="col-md-9">
(STEP) Electromechanical Response Characterisation Program<br>
</div>
</div>
<div class="row mrgn-bttm-md">
<div class="col-md-12">
Measures the electromechanical response of a material through a comprehensive instrumentation interface. A variety of piezoelectric, electrostrictive and ferroelectric models are available for analysing the data<br>
<br>
</div>
</div>
<div class="row mrgn-bttm-md">
<div class="col-md-3">
<strong>
Out-License (Offering):
</strong>
</div>
<div class="col-md-9">
XRFWin<br>
</div>
</div>
<div class="row mrgn-bttm-md">
<div class="col-md-12">
X-ray Fluorescence Analysis Platform for qualitative and quantitative analysis of samples by XRF. Support for EDS and WDS spectrometers. Analysis capability includes fundamental parameters in bulk, single layer and multi-layer configurations.<br>
<br>
</div>
</div>
<div class="row mrgn-bttm-md">
<div class="col-md-3">
<strong>
FSC Code:
</strong>
</div>
<div class="col-md-9">
AD00-Defense - Other
<br>
AJ00-General Science and Technology
<br>
AN00-Medical
<br>
</div>
</div>
</section>
<p class="mrgn-tp-lg text-right small hidden-print">
<a href="#wb-cont">top of page</a>
</p>
<!-- Technology Profile -->
<!-- Market Profile -->
<!-- Sector Information -->
<details class="mrgn-tp-md mrgn-bttm-md">
<summary>
Third-Party Information Liability Disclaimer
</summary>
<p>
Some of the information on this Web page has been provided by external sources. The Government of Canada is not responsible for the accuracy, reliability or currency of the information supplied by external sources. Users wishing to rely upon this information should consult directly with the source of the information. Content provided by external sources is not subject to official languages, privacy and accessibility requirements.
</p>
</details>
</details>
<details id="details-panel2">
<summary>
Contacts
</summary>
<h2 class="wb-invisible">
Contact information
</h2>
<!-- Contact Information -->
<section class="container-fluid">
<div class="row mrgn-tp-lg">
<div class="col-md-3">
<strong>
Ron
Tasker
</strong></div>
</div>
<div class="row mrgn-lft-md">
<div class="col-md-5">
<strong>
Title:
</strong>
</div>
<div class="col-md-7">
<!--if client gender is not null or empty we use gender based job title-->
President
</div>
</div>
<div class="row mrgn-lft-md">
<div class="col-md-5">
<strong>
Telephone:
</strong>
</div>
<div class="col-md-7">
(416) 964-2108
</div>
</div>
<div class="row mrgn-lft-md">
<div class="col-md-5">
<strong>
Facsimile:
</strong>
</div>
<div class="col-md-7">
(416) 960-9245
</div>
</div>
<div class="row mrgn-lft-md">
<div class="col-md-5">
<strong>
Email:
</strong>
</div>
<div class="col-md-7">
[email protected]
</div>
</div>
</section>
</details>
<details id="details-panel3">
<summary>
Description
</summary>
<h2 class="wb-invisible">
Company description
</h2>
<section class="container-fluid">
<div class="row">
<div class="col-md-5">
<strong>
Exporting:
</strong>
</div>
<div class="col-md-7">
Yes
</div>
</div>
<div class="row">
<div class="col-md-5">
<strong>
Primary Industry (NAICS):
</strong>
</div>
<div class="col-md-7">
511210 - Software Publishers
</div>
</div>
<div class="row">
<div class="col-md-5">
<strong>
Alternate Industries (NAICS):
</strong>
</div>
<div class="col-md-7">
541510 - Computer Systems Design and Related Services<br>
</div>
</div>
<div class="row">
<div class="col-md-5">
<strong>
Primary Business Activity:
</strong>
</div>
<div class="col-md-7">
Manufacturer / Processor / Producer
</div>
</div>
</section>
</details>
<details id="details-panel4">
<summary>
Products, services and licensing
</summary>
<h2 class="wb-invisible">
Product / Service / Licensing
</h2>
<section class="container-fluid">
<div class="row mrgn-bttm-md">
<div class="col-md-3">
<strong>
Product Name:
</strong>
</div>
<div class="col-md-9">
(PRAP) Piezoelectric Resonance Analysis Program<br>
</div>
</div>
<div class="row mrgn-bttm-md">
<div class="col-md-12">
Acquires and analyses electrical impedance spectra in frequency
<br>
of piezoelectric resonators. Resonance spectrum is analysed to
<br>
determine complex material properties.<br>
<br>
</div>
</div>
<div class="row mrgn-bttm-md">
<div class="col-md-3">
<strong>
Product Name:
</strong>
</div>
<div class="col-md-9">
(STEP) Electromechanical Response Characterisation Program<br>
</div>
</div>
<div class="row mrgn-bttm-md">
<div class="col-md-12">
Measures the electromechanical response of a material through a comprehensive instrumentation interface. A variety of piezoelectric, electrostrictive and ferroelectric models are available for analysing the data<br>
<br>
</div>
</div>
<div class="row mrgn-bttm-md">
<div class="col-md-3">
<strong>
Out-License (Offering):
</strong>
</div>
<div class="col-md-9">
XRFWin<br>
</div>
</div>
<div class="row mrgn-bttm-md">
<div class="col-md-12">
X-ray Fluorescence Analysis Platform for qualitative and quantitative analysis of samples by XRF. Support for EDS and WDS spectrometers. Analysis capability includes fundamental parameters in bulk, single layer and multi-layer configurations.<br>
<br>
</div>
</div>
<div class="row mrgn-bttm-md">
<div class="col-md-3">
<strong>
FSC Code:
</strong>
</div>
<div class="col-md-9">
AD00-Defense - Other
<br>
AJ00-General Science and Technology
<br>
AN00-Medical
<br>
</div>
</div>
</section>
</details>
</div>
</div>
<div class="row">
<div class="col-md-12 text-right">
Last Update Date 2017-03-23
</div>
</div>
<!--
- Artifact ID: CBW - IMBS - CCC Search WAR
- Group ID: ca.gc.ic.strategis.imbs.ccc.search
- Version: 3.26
- Built-By: bamboo
- Build Timestamp: 2017-03-02T21:29:28Z
-->
<!-- End Body Content -->
<!-- Begin Body Foot -->
<!-- End Body Foot -->
<!-- END MAIN TABLE -->
<!-- End body -->
<!-- Begin footer -->
<div class="row pagedetails">
<div class="col-sm-5 col-xs-12 datemod">
<dl id="wb-dtmd">
<dt class=" hidden-print">Date Modified:</dt>
<dd class=" hidden-print">
<span><time>2017-03-02</time></span>
</dd>
</dl>
</div>
<div class="clear visible-xs"></div>
<div class="col-sm-4 col-xs-6">
</div>
<div class="col-sm-3 col-xs-6 text-right">
</div>
<div class="clear visible-xs"></div>
</div>
</main>
<footer role="contentinfo" id="wb-info">
<nav role="navigation" class="container wb-navcurr">
<h2 class="wb-inv">About government</h2>
<!-- EPIC FOOTER BEGIN -->
<!-- EPI-11638 Contact us -->
<ul class="list-unstyled colcount-sm-2 colcount-md-3">
<li><a href="http://www.ic.gc.ca/eic/site/icgc.nsf/eng/h_07026.html#pageid=E048-H00000&from=Industries">Contact us</a></li>
<li><a href="https://www.canada.ca/en/government/dept.html">Departments and agencies</a></li>
<li><a href="https://www.canada.ca/en/government/publicservice.html">Public service and military</a></li>
<li><a href="https://www.canada.ca/en/news.html">News</a></li>
<li><a href="https://www.canada.ca/en/government/system/laws.html">Treaties, laws and regulations</a></li>
<li><a href="https://www.canada.ca/en/transparency/reporting.html">Government-wide reporting</a></li>
<li><a href="http://pm.gc.ca/eng">Prime Minister</a></li>
<li><a href="https://www.canada.ca/en/government/system.html">How government works</a></li>
<li><a href="http://open.canada.ca/en/">Open government</a></li>
</ul>
</nav>
<div class="brand">
<div class="container">
<div class="row">
<nav class="col-md-10 ftr-urlt-lnk">
<h2 class="wb-inv">About this site</h2>
<ul>
<li><a href="https://www.canada.ca/en/social.html">Social media</a></li>
<li><a href="https://www.canada.ca/en/mobile.html">Mobile applications</a></li>
<li><a href="http://www1.canada.ca/en/newsite.html">About Canada.ca</a></li>
<li><a href="http://www.ic.gc.ca/eic/site/icgc.nsf/eng/h_07033.html">Terms and conditions</a></li>
<li><a href="http://www.ic.gc.ca/eic/site/icgc.nsf/eng/h_07033.html#p1">Privacy</a></li>
</ul>
</nav>
<div class="col-xs-6 visible-sm visible-xs tofpg">
<a href="#wb-cont">Top of Page <span class="glyphicon glyphicon-chevron-up"></span></a>
</div>
<div class="col-xs-6 col-md-2 text-right">
<object type="image/svg+xml" tabindex="-1" role="img" data="/utils/scripts/_WET_4-0/apps/themes-dist/gcweb/assets/wmms-blk.svg" aria-label="Symbol of the Government of Canada"></object>
</div>
</div>
</div>
</div>
</footer>
<!--[if gte IE 9 | !IE ]><!-->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="/utils/scripts/_WET_4-0/apps/themes-dist/gcweb/js/wet-boew.min.js"></script>
<!--<![endif]-->
<!--[if lt IE 9]>
<script src="/utils/scripts/_WET_4-0/apps/themes-dist/gcweb/js/ie8-wet-boew2.min.js"></script>
<![endif]-->
<script src="/utils/scripts/_WET_4-0/apps/themes-dist/gcweb/js/theme.min.js"></script>
<!-- EPI-10519 -->
<span class="wb-sessto"
data-wb-sessto='{"inactivity": 1800000, "reactionTime": 180000, "sessionalive": 1800000, "logouturl": "/app/ccc/srch/cccSrch.do?lang=eng&prtl=1"}'></span>
<script src="/eic/home.nsf/js/jQuery.externalOpensInNewWindow.js"></script>
<!-- EPI-11190 - Webtrends -->
<script src="/eic/home.nsf/js/webtrends.js"></script>
<script>var endTime = new Date();</script>
<noscript>
<div><img alt="" id="DCSIMG" width="1" height="1" src="//wt-sdc.ic.gc.ca/dcs6v67hwe0ei7wsv8g9fv50d_3k6i/njs.gif?dcsuri=/nojavascript&WT.js=No&WT.tv=9.4.0&dcssip=www.ic.gc.ca"/></div>
</noscript>
<!-- /Webtrends -->
<!-- JS deps -->
<script src="/eic/home.nsf/js/jquery.imagesloaded.js"></script>
<!-- EPI-11262 - Util JS -->
<script src="/eic/home.nsf/js/_WET_4-0_utils_canada.min.js"></script>
<!-- EPI-11383 -->
<script src="/eic/home.nsf/js/jQuery.icValidationErrors.js"></script>
<span style="display:none;" id='app-info' data-project-groupid='' data-project-artifactid='' data-project-version='' data-project-build-timestamp='' data-issue-tracking='' data-scm-sha1='' data-scm-sha1-abbrev='' data-scm-branch='' data-scm-commit-date=''></span>
</body></html>
<!-- End Footer -->
<!--
- Artifact ID: CBW - IMBS - CCC Search WAR
- Group ID: ca.gc.ic.strategis.imbs.ccc.search
- Version: 3.26
- Built-By: bamboo
- Build Timestamp: 2017-03-02T21:29:28Z
-->
|
GoC-Spending/data-corporations
|
html/234567058433.html
|
HTML
|
mit
| 42,694 |
<div class="nav">
<h3 class="nav-title">Menu</h3>
<a href="#" class="nav-close">
<span class="hidden">Close</span>
</a>
<ul>
<li class="nav-home {% if page.current == 'home' %} nav-current{% endif %}" role="presentation"><a href="{{ site.baseurl }}">Home</a></li>
<li class="nav-author {% if page.current == 'author' %} nav-current{% endif %}" role="presentation"><a href="{{ site.baseurl }}author/giovanni">Author</a></li>
</ul>
<a class="subscribe-button icon-feed" href="{{ site.baseurl }}feed.xml">Subscribe</a>
</div>
<span class="nav-cover"></span>
|
gvsi/cs371p
|
_includes/navigation.html
|
HTML
|
mit
| 603 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.