UNPKG

carbon-components-angular

Version:
1,897 lines 104 kB
<!doctype html>
<html class="no-js" lang="">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="x-ua-compatible" content="ie=edge">
        <title>carbon-components-angular documentation</title>
        <meta name="description" content="">
        <meta name="viewport" content="width=device-width, initial-scale=1">

        <link rel="icon" type="image/x-icon" href="../images/favicon.ico">
	    <link rel="stylesheet" href="../styles/style.css">
    </head>
    <body>

        <div class="navbar navbar-default navbar-fixed-top visible-xs">
            <a href="../" class="navbar-brand">carbon-components-angular documentation</a>
            <button type="button" class="btn btn-default btn-menu fa fa-bars" id="btn-menu"></button>
        </div>

        <div class="xs-menu menu" id="mobile-menu">
            <div id="book-search-input" role="search">
                <input type="text" placeholder="Type to search">
            </div>
            <nav>
            
                <ul class="list">
            
                    <li class="title">
                        <a href="../index.html">carbon-components-angular documentation</a>
                    </li>
            
                    <li class="divider"></li>
            
            
                    <li class="chapter">
                        <a data-type="chapter-link" href="../index.html"><span class="fa fa-home"></span>Getting started</a>
                        <ul class="links">
                                <li class="link">
                                    <a 
                                        
                                         href="../overview.html" 
                                         href="../overview.html" 
                                        >
                                        <span class="fa fa-th"></span>Overview
                                    </a>
                                </li>
                                <li class="link">
                                  <a href="../index.html" ><span class="fa fa-file-text-o"></span>README</a>
                                </li>
                                <li class="link">
                                        <a href="../changelog.html"
                                    >
                                        <span class="fa fa-file-text-o"></span>CHANGELOG
                                    </a>
                                </li>
                                <li class="link">
                                        <a href="../license.html"
                                    >
                                        <span class="fa fa-file-text-o"></span>LICENSE
                                    </a>
                                </li>
                        </ul>
                    </li>
            
            
                    <li class="chapter">
                        <a data-type="chapter-link" href="../modules.html" >
                            <div class="menu-toggler linked" data-toggle="collapse"
                                    data-target="#xs-modules-links"
                            >
                                <span class="fa fa-archive"></span>
                                <span class="link-name">Modules</span>
                                <span class="fa fa-angle-down"></span>
                            </div>
                        </a>
                        <ul class="links collapse "
                                id="xs-modules-links"
                            >
                                <li class="link">
                                    <a href="../modules/AccordionModule.html" >AccordionModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/BannerModule.html" >BannerModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/ButtonModule.html" >ButtonModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/CalendarModule.html" >CalendarModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/CheckboxModule.html" >CheckboxModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/CodeSnippetModule.html" >CodeSnippetModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/ComboBoxModule.html" >ComboBoxModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/ContentSwitcherModule.html" >ContentSwitcherModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/DialogModule.html" >DialogModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/DropdownModule.html" >DropdownModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/I18nModule.html" >I18nModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/IconModule.html" >IconModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/InputModule.html" >InputModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/LinkModule.html" >LinkModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/ListGroupModule.html" >ListGroupModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/LoadingModule.html" >LoadingModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/ModalModule.html" >ModalModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/NFormsModule.html" >NFormsModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/NotificationModule.html" >NotificationModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/PaginationModule.html" >PaginationModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/PillInputModule.html" >PillInputModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/PlaceholderModule.html" >PlaceholderModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/ProgressIndicatorModule.html" >ProgressIndicatorModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/RadioModule.html" >RadioModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/SampleModule.html" >SampleModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/SelectModule.html" >SelectModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/StaticIconModule.html" >StaticIconModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/SwitchModule.html" >SwitchModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/TableModule.html" >TableModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/TabsModule.html" >TabsModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/TilesModule.html" >TilesModule</a>
                                </li>
                                <li class="link">
                                    <a href="../modules/ToggleModule.html" >ToggleModule</a>
                                </li>
                        </ul>
                    </li>
            
                    <li class="chapter">
                        <div class="simple menu-toggler" data-toggle="collapse"
                                data-target="#xs-components-links"
                            >
                            <span class="fa fa-cogs"></span>
                            <span>Components</span>
                            <span class="fa fa-angle-down"></span>
                        </div>
                        <ul class="links collapse "
                                id="xs-components-links"
                            >
                                <li class="link">
                                    <a href="../components/Accordion.html" >Accordion</a>
                                </li>
                                <li class="link">
                                    <a href="../components/AccordionItem.html" >AccordionItem</a>
                                </li>
                                <li class="link">
                                    <a href="../components/AlertModal.html" >AlertModal</a>
                                </li>
                                <li class="link">
                                    <a href="../components/AlertModalStory.html" >AlertModalStory</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Banner.html" >Banner</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Calendar.html" >Calendar</a>
                                </li>
                                <li class="link">
                                    <a href="../components/CalendarHeader.html"  data-type="entity-link" class="active" >CalendarHeader</a>
                                </li>
                                <li class="link">
                                    <a href="../components/CalendarMonth.html" >CalendarMonth</a>
                                </li>
                                <li class="link">
                                    <a href="../components/CalendarMonths.html" >CalendarMonths</a>
                                </li>
                                <li class="link">
                                    <a href="../components/CalendarQuarter.html" >CalendarQuarter</a>
                                </li>
                                <li class="link">
                                    <a href="../components/CalendarYear.html" >CalendarYear</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Checkbox.html" >Checkbox</a>
                                </li>
                                <li class="link">
                                    <a href="../components/ClickableTile.html" >ClickableTile</a>
                                </li>
                                <li class="link">
                                    <a href="../components/CodeSnippet.html" >CodeSnippet</a>
                                </li>
                                <li class="link">
                                    <a href="../components/ComboBox.html" >ComboBox</a>
                                </li>
                                <li class="link">
                                    <a href="../components/ContentSwitcher.html" >ContentSwitcher</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Dialog.html" >Dialog</a>
                                </li>
                                <li class="link">
                                    <a href="../components/DialogPlaceholder.html" >DialogPlaceholder</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Dropdown.html" >Dropdown</a>
                                </li>
                                <li class="link">
                                    <a href="../components/DropdownList.html" >DropdownList</a>
                                </li>
                                <li class="link">
                                    <a href="../components/DynamicTableStory.html" >DynamicTableStory</a>
                                </li>
                                <li class="link">
                                    <a href="../components/ExpansionTableStory.html" >ExpansionTableStory</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Icon.html" >Icon</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Label.html" >Label</a>
                                </li>
                                <li class="link">
                                    <a href="../components/ListGroup.html" >ListGroup</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Loading.html" >Loading</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Modal.html" >Modal</a>
                                </li>
                                <li class="link">
                                    <a href="../components/ModalFooter.html" >ModalFooter</a>
                                </li>
                                <li class="link">
                                    <a href="../components/ModalHeader.html" >ModalHeader</a>
                                </li>
                                <li class="link">
                                    <a href="../components/ModalPlaceholder.html" >ModalPlaceholder</a>
                                </li>
                                <li class="link">
                                    <a href="../components/ModalStory.html" >ModalStory</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Notification.html" >Notification</a>
                                </li>
                                <li class="link">
                                    <a href="../components/NotificationStory.html" >NotificationStory</a>
                                </li>
                                <li class="link">
                                    <a href="../components/OverflowMenu.html" >OverflowMenu</a>
                                </li>
                                <li class="link">
                                    <a href="../components/OverflowMenuOption.html" >OverflowMenuOption</a>
                                </li>
                                <li class="link">
                                    <a href="../components/OverflowMenuPane.html" >OverflowMenuPane</a>
                                </li>
                                <li class="link">
                                    <a href="../components/OverflowTableStory.html" >OverflowTableStory</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Overlay.html" >Overlay</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Pagination.html" >Pagination</a>
                                </li>
                                <li class="link">
                                    <a href="../components/PaginationStory.html" >PaginationStory</a>
                                </li>
                                <li class="link">
                                    <a href="../components/PaginationTableStory.html" >PaginationTableStory</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Pill.html" >Pill</a>
                                </li>
                                <li class="link">
                                    <a href="../components/PillInput.html" >PillInput</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Placeholder.html" >Placeholder</a>
                                </li>
                                <li class="link">
                                    <a href="../components/ProgressIndicator.html" >ProgressIndicator</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Radio.html" >Radio</a>
                                </li>
                                <li class="link">
                                    <a href="../components/RadioGroup.html" >RadioGroup</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Sample.html" >Sample</a>
                                </li>
                                <li class="link">
                                    <a href="../components/SampleModal.html" >SampleModal</a>
                                </li>
                                <li class="link">
                                    <a href="../components/SampleSub.html" >SampleSub</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Select.html" >Select</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Sprite.html" >Sprite</a>
                                </li>
                                <li class="link">
                                    <a href="../components/StaticIcon.html" >StaticIcon</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Switch.html" >Switch</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Tab.html" >Tab</a>
                                </li>
                                <li class="link">
                                    <a href="../components/TabHeaders.html" >TabHeaders</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Table.html" >Table</a>
                                </li>
                                <li class="link">
                                    <a href="../components/TableStory.html" >TableStory</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Tabs.html" >Tabs</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Tile.html" >Tile</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Toast.html" >Toast</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Toast.html" >Toast</a>
                                </li>
                                <li class="link">
                                    <a href="../components/ToastStory.html" >ToastStory</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Toggle.html" >Toggle</a>
                                </li>
                                <li class="link">
                                    <a href="../components/Tooltip.html" >Tooltip</a>
                                </li>
                        </ul>
                    </li>
            
                    <li class="chapter">
                        <div class="simple menu-toggler" data-toggle="collapse"
                                data-target="#xs-directives-links"
                            >
                            <span class="fa fa-code"></span>
                            <span>Directives</span>
                            <span class="fa fa-angle-down"></span>
                        </div>
                        <ul class="links collapse "
                                id="xs-directives-links"
                            >
                                <li class="link">
                                    <a href="../directives/Button.html" >Button</a>
                                </li>
                                <li class="link">
                                    <a href="../directives/ContentSwitcherOption.html" >ContentSwitcherOption</a>
                                </li>
                                <li class="link">
                                    <a href="../directives/DialogDirective.html" >DialogDirective</a>
                                </li>
                                <li class="link">
                                    <a href="../directives/EllipsisTooltip.html" >EllipsisTooltip</a>
                                </li>
                                <li class="link">
                                    <a href="../directives/Link.html" >Link</a>
                                </li>
                                <li class="link">
                                    <a href="../directives/OptGroup.html" >OptGroup</a>
                                </li>
                                <li class="link">
                                    <a href="../directives/Option.html" >Option</a>
                                </li>
                                <li class="link">
                                    <a href="../directives/OverflowMenuDirective.html" >OverflowMenuDirective</a>
                                </li>
                                <li class="link">
                                    <a href="../directives/ScrollableList.html" >ScrollableList</a>
                                </li>
                                <li class="link">
                                    <a href="../directives/TextArea.html" >TextArea</a>
                                </li>
                                <li class="link">
                                    <a href="../directives/TextInput.html" >TextInput</a>
                                </li>
                                <li class="link">
                                    <a href="../directives/TooltipDirective.html" >TooltipDirective</a>
                                </li>
                        </ul>
                    </li>
            
                    <li class="chapter">
                        <div class="simple menu-toggler" data-toggle="collapse"
                                data-target="#xs-classes-links"
                            >
                            <span class="fa fa-file-code-o"></span>
                            <span>Classes</span>
                            <span class="fa fa-angle-down"></span>
                        </div>
                        <ul class="links collapse "
                                id="xs-classes-links"
                            >
                                <li class="link">
                                    <a href="../classes/AbstractDropdownView.html" >AbstractDropdownView</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/BaseModal.html" >BaseModal</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/CheckboxChange.html" >CheckboxChange</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/CustomHeaderItem.html" >CustomHeaderItem</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/DateTimeModel.html" >DateTimeModel</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/ModalContainer.html" >ModalContainer</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/PaginationModel.html" >PaginationModel</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/RadioChange.html" >RadioChange</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/SampleBase.html" >SampleBase</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/SwitchChange.html" >SwitchChange</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/TableHeaderItem.html" >TableHeaderItem</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/TableItem.html" >TableItem</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/TableModel.html" >TableModel</a>
                                </li>
                                <li class="link">
                                    <a href="../classes/ToggleChange.html" >ToggleChange</a>
                                </li>
                        </ul>
                    </li>
            
                    <li class="chapter">
                        <div class="simple menu-toggler" data-toggle="collapse"
                                data-target="#xs-injectables-links"
                            >
                            <span class="fa fa-long-arrow-down"></span>
                            <span>Injectables</span>
                            <span class="fa fa-angle-down"></span>
                        </div>
                        <ul class="links collapse "
                                id="xs-injectables-links"
                            >
                                <li class="link">
                                    <a href="../injectables/BannerService.html" >BannerService</a>
                                </li>
                                <li class="link">
                                    <a href="../injectables/DialogService.html" >DialogService</a>
                                </li>
                                <li class="link">
                                    <a href="../injectables/I18n.html" >I18n</a>
                                </li>
                                <li class="link">
                                    <a href="../injectables/IconService.html" >IconService</a>
                                </li>
                                <li class="link">
                                    <a href="../injectables/ModalService.html" >ModalService</a>
                                </li>
                                <li class="link">
                                    <a href="../injectables/NotificationDisplayService.html" >NotificationDisplayService</a>
                                </li>
                                <li class="link">
                                    <a href="../injectables/NotificationService.html" >NotificationService</a>
                                </li>
                                <li class="link">
                                    <a href="../injectables/PlaceholderService.html" >PlaceholderService</a>
                                </li>
                        </ul>
                    </li>
            
            
                    <li class="chapter">
                        <div class="simple menu-toggler" data-toggle="collapse"
                                data-target="#xs-interfaces-links"
                            >
                            <span class="fa fa-info"></span>
                            <span>Interfaces</span>
                            <span class="fa fa-angle-down"></span>
                        </div>
                        <ul class="links collapse "
                                id="xs-interfaces-links"
                            >
                                <li class="link">
                                    <a href="../interfaces/AbsolutePosition.html" >AbsolutePosition</a>
                                </li>
                                <li class="link">
                                    <a href="../interfaces/AlertModalData.html" >AlertModalData</a>
                                </li>
                                <li class="link">
                                    <a href="../interfaces/BannerContent.html" >BannerContent</a>
                                </li>
                                <li class="link">
                                    <a href="../interfaces/DialogConfig.html" >DialogConfig</a>
                                </li>
                                <li class="link">
                                    <a href="../interfaces/ListItem.html" >ListItem</a>
                                </li>
                                <li class="link">
                                    <a href="../interfaces/ModalButton.html" >ModalButton</a>
                                </li>
                                <li class="link">
                                    <a href="../interfaces/NotificationContent.html" >NotificationContent</a>
                                </li>
                                <li class="link">
                                    <a href="../interfaces/NotificationContent.html" >NotificationContent</a>
                                </li>
                                <li class="link">
                                    <a href="../interfaces/SampleInterface.html" >SampleInterface</a>
                                </li>
                                <li class="link">
                                    <a href="../interfaces/SizeMap.html" >SizeMap</a>
                                </li>
                                <li class="link">
                                    <a href="../interfaces/ToastContent.html" >ToastContent</a>
                                </li>
                                <li class="link">
                                    <a href="../interfaces/ToastContent.html" >ToastContent</a>
                                </li>
                        </ul>
                    </li>
            
            
                    <li class="chapter">
                        <div class="simple menu-toggler" data-toggle="collapse"
                                data-target="#xs-miscellaneous-links"
                            >
                            <span class="fa fa-cubes"></span>
                            <span>Miscellaneous</span>
                            <span class="fa fa-angle-down"></span>
                        </div>
                        <ul class="links collapse "
                                id="xs-miscellaneous-links"
                            >
                                <li class="link">
                                  <a href="../miscellaneous/enumerations.html" data-type="entity-link" >Enums</a>
                                </li>
                                <li class="link">
                                  <a href="../miscellaneous/functions.html" data-type="entity-link" >Functions</a>
                                </li>
                                <li class="link">
                                  <a href="../miscellaneous/typealiases.html" data-type="entity-link" >Type aliases</a>
                                </li>
                                <li class="link">
                                  <a href="../miscellaneous/variables.html" data-type="entity-link" >Variables</a>
                                </li>
                        </ul>
                    </li>
            
            
                    <li class="chapter">
                        <a data-type="chapter-link" href="../coverage.html" ><span class="fa fa-tasks"></span>Documentation coverage</a>
                    </li>
            
                    <li class="divider"></li>
                    <li class="copyright">
                            Documentation generated using <a href="https://compodoc.github.io/website/" target="_blank">
                                        <img src="..//images/compodoc-vectorise.svg" class="img-responsive">
                            </a>
                    </li>
            
                </ul>
            
            </nav>
        </div>

        <div class="container-fluid main">
           <div class="row main">
               <div class="hidden-xs menu">
                   <nav>
                   
                       <ul class="list">
                   
                           <li class="title">
                               <a href="../index.html">carbon-components-angular documentation</a>
                           </li>
                   
                           <li class="divider"></li>
                   
                               <div id="book-search-input" role="search">
                                   <input type="text" placeholder="Type to search">
                               </div>
                   
                           <li class="chapter">
                               <a data-type="chapter-link" href="../index.html"><span class="fa fa-home"></span>Getting started</a>
                               <ul class="links">
                                       <li class="link">
                                           <a 
                                               
                                                href="../overview.html" 
                                                href="../overview.html" 
                                               >
                                               <span class="fa fa-th"></span>Overview
                                           </a>
                                       </li>
                                       <li class="link">
                                         <a href="../index.html" ><span class="fa fa-file-text-o"></span>README</a>
                                       </li>
                                       <li class="link">
                                               <a href="../changelog.html"
                                           >
                                               <span class="fa fa-file-text-o"></span>CHANGELOG
                                           </a>
                                       </li>
                                       <li class="link">
                                               <a href="../license.html"
                                           >
                                               <span class="fa fa-file-text-o"></span>LICENSE
                                           </a>
                                       </li>
                               </ul>
                           </li>
                   
                   
                           <li class="chapter">
                               <a data-type="chapter-link" href="../modules.html" >
                                   <div class="menu-toggler linked" data-toggle="collapse"
                                           data-target="#modules-links"
                                   >
                                       <span class="fa fa-archive"></span>
                                       <span class="link-name">Modules</span>
                                       <span class="fa fa-angle-down"></span>
                                   </div>
                               </a>
                               <ul class="links collapse "
                                       id="modules-links"
                   >
                                       <li class="link">
                                           <a href="../modules/AccordionModule.html" >AccordionModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/BannerModule.html" >BannerModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/ButtonModule.html" >ButtonModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/CalendarModule.html" >CalendarModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/CheckboxModule.html" >CheckboxModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/CodeSnippetModule.html" >CodeSnippetModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/ComboBoxModule.html" >ComboBoxModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/ContentSwitcherModule.html" >ContentSwitcherModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/DialogModule.html" >DialogModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/DropdownModule.html" >DropdownModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/I18nModule.html" >I18nModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/IconModule.html" >IconModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/InputModule.html" >InputModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/LinkModule.html" >LinkModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/ListGroupModule.html" >ListGroupModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/LoadingModule.html" >LoadingModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/ModalModule.html" >ModalModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/NFormsModule.html" >NFormsModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/NotificationModule.html" >NotificationModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/PaginationModule.html" >PaginationModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/PillInputModule.html" >PillInputModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/PlaceholderModule.html" >PlaceholderModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/ProgressIndicatorModule.html" >ProgressIndicatorModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/RadioModule.html" >RadioModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/SampleModule.html" >SampleModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/SelectModule.html" >SelectModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/StaticIconModule.html" >StaticIconModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/SwitchModule.html" >SwitchModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/TableModule.html" >TableModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/TabsModule.html" >TabsModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/TilesModule.html" >TilesModule</a>
                                       </li>
                                       <li class="link">
                                           <a href="../modules/ToggleModule.html" >ToggleModule</a>
                                       </li>
                               </ul>
                           </li>
                   
                           <li class="chapter">
                               <div class="simple menu-toggler" data-toggle="collapse"
                                       data-target="#components-links"
                   >
                                   <span class="fa fa-cogs"></span>
                                   <span>Components</span>
                                   <span class="fa fa-angle-down"></span>
                               </div>
                               <ul class="links collapse "
                                       id="components-links"
                   >
                                       <li class="link">
                                           <a href="../components/Accordion.html" >Accordion</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/AccordionItem.html" >AccordionItem</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/AlertModal.html" >AlertModal</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/AlertModalStory.html" >AlertModalStory</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Banner.html" >Banner</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Calendar.html" >Calendar</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/CalendarHeader.html"  data-type="entity-link" class="active" >CalendarHeader</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/CalendarMonth.html" >CalendarMonth</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/CalendarMonths.html" >CalendarMonths</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/CalendarQuarter.html" >CalendarQuarter</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/CalendarYear.html" >CalendarYear</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Checkbox.html" >Checkbox</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/ClickableTile.html" >ClickableTile</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/CodeSnippet.html" >CodeSnippet</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/ComboBox.html" >ComboBox</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/ContentSwitcher.html" >ContentSwitcher</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Dialog.html" >Dialog</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/DialogPlaceholder.html" >DialogPlaceholder</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Dropdown.html" >Dropdown</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/DropdownList.html" >DropdownList</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/DynamicTableStory.html" >DynamicTableStory</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/ExpansionTableStory.html" >ExpansionTableStory</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Icon.html" >Icon</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Label.html" >Label</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/ListGroup.html" >ListGroup</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Loading.html" >Loading</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Modal.html" >Modal</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/ModalFooter.html" >ModalFooter</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/ModalHeader.html" >ModalHeader</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/ModalPlaceholder.html" >ModalPlaceholder</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/ModalStory.html" >ModalStory</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Notification.html" >Notification</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/NotificationStory.html" >NotificationStory</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/OverflowMenu.html" >OverflowMenu</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/OverflowMenuOption.html" >OverflowMenuOption</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/OverflowMenuPane.html" >OverflowMenuPane</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/OverflowTableStory.html" >OverflowTableStory</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Overlay.html" >Overlay</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Pagination.html" >Pagination</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/PaginationStory.html" >PaginationStory</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/PaginationTableStory.html" >PaginationTableStory</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Pill.html" >Pill</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/PillInput.html" >PillInput</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Placeholder.html" >Placeholder</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/ProgressIndicator.html" >ProgressIndicator</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Radio.html" >Radio</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/RadioGroup.html" >RadioGroup</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Sample.html" >Sample</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/SampleModal.html" >SampleModal</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/SampleSub.html" >SampleSub</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Select.html" >Select</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Sprite.html" >Sprite</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/StaticIcon.html" >StaticIcon</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Switch.html" >Switch</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Tab.html" >Tab</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/TabHeaders.html" >TabHeaders</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Table.html" >Table</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/TableStory.html" >TableStory</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Tabs.html" >Tabs</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Tile.html" >Tile</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Toast.html" >Toast</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Toast.html" >Toast</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/ToastStory.html" >ToastStory</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Toggle.html" >Toggle</a>
                                       </li>
                                       <li class="link">
                                           <a href="../components/Tooltip.html" >Tooltip</a>
                                       </li>
                               </ul>
                           </li>
                   
                           <li class="chapter">
                               <div class="simple menu-toggler" data-toggle="collapse"
                                       data-target="#directives-links"
                   >
                                   <span class="fa fa-code"></span>
                                   <span>Directives</span>
                                   <span class="fa fa-angle-down"></span>
                               </div>
                               <ul class="links collapse "
                                       id="directives-links"
                   >
                                       <li class="link">
                                           <a href="../directives/Button.html" >Button</a>
                                       </li>
                                       <li class="link">
                                           <a href="../directives/ContentSwitcherOption.html" >ContentSwitcherOption</a>
                                       </li>
                                       <li class="link">
                                           <a href="../directives/DialogDirective.html" >DialogDirective</a>
                                       </li>
                                       <li class="link">
                                           <a href="../directives/EllipsisTooltip.html" >EllipsisTooltip</a>
                                       </li>
                                       <li class="link">
                                           <a href="../directives/Link.html" >Link</a>
                                       </li>
                                       <li class="link">
                                           <a href="../directives/OptGroup.html" >OptGroup</a>
                                       </li>
                                       <li class="link">
                                           <a href="../directives/Option.html" >Option</a>
                                       </li>
                                       <li class="link">
                                           <a href="../directives/OverflowMenuDirective.html" >OverflowMenuDirective</a>
                                       </li>
                                       <li class="link">
                                           <a href="../directives/ScrollableList.html" >ScrollableList</a>
                                       </li>
                                       <li class="link">
                                           <a href="../directives/TextArea.html" >TextArea</a>
                                       </li>
                                       <li class="link">
                                           <a href="../directives/TextInput.html" >TextInput</a>
                                       </li>
                                       <li class="link">
                                           <a href="../directives/TooltipDirective.html" >TooltipDirective</a>
                                       </li>
                               </ul>
                           </li>
                   
                           <li class="chapter">
                               <div class="simple menu-toggler" data-toggle="collapse"
                                       data-target="#classes-links"
                   >
                                   <span class="fa fa-file-code-o"></span>
                                   <span>Classes</span>
                                   <span class="fa fa-angle-down"></span>
                               </div>
                               <ul class="links collapse "
                                       id="classes-links"
                   >
                                       <li class="link">
                                           <a href="../classes/AbstractDropdownView.html" >AbstractDropdownView</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/BaseModal.html" >BaseModal</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/CheckboxChange.html" >CheckboxChange</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/CustomHeaderItem.html" >CustomHeaderItem</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/DateTimeModel.html" >DateTimeModel</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/ModalContainer.html" >ModalContainer</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/PaginationModel.html" >PaginationModel</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/RadioChange.html" >RadioChange</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/SampleBase.html" >SampleBase</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/SwitchChange.html" >SwitchChange</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/TableHeaderItem.html" >TableHeaderItem</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/TableItem.html" >TableItem</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/TableModel.html" >TableModel</a>
                                       </li>
                                       <li class="link">
                                           <a href="../classes/ToggleChange.html" >ToggleChange</a>
                                       </li>
                               </ul>
                           </li>
                   
                           <li class="chapter">
                               <div class="simple menu-toggler" data-toggle="collapse"
                                       data-target="#injectables-links"
                   >
                                   <span class="fa fa-long-arrow-down"></span>
                                   <span>Injectables</span>
                                   <span class="fa fa-angle-down"></span>
                               </div>
                               <ul class="links collapse "
                                       id="injectables-links"
                   >
                                       <li class="link">
                                           <a href="../injectables/BannerService.html" >BannerService</a>
                                       </li>
                                       <li class="link">
                                           <a href="../injectables/DialogService.html" >DialogService</a>
                                       </li>
                                       <li class="link">
                                           <a href="../injectables/I18n.html" >I18n</a>
                                       </li>
                                       <li class="link">
                                           <a href="../injectables/IconService.html" >IconService</a>
                                       </li>
                                       <li class="link">
                                           <a href="../injectables/ModalService.html" >ModalService</a>
                                       </li>
                                       <li class="link">
                                           <a href="../injectables/NotificationDisplayService.html" >NotificationDisplayService</a>
                                       </li>
                                       <li class="link">
                                           <a href="../injectables/NotificationService.html" >NotificationService</a>
                                       </li>
                                       <li class="link">
                                           <a href="../injectables/PlaceholderService.html" >PlaceholderService</a>
                                       </li>
                               </ul>
                           </li>
                   
                   
                           <li class="chapter">
                               <div class="simple menu-toggler" data-toggle="collapse"
                                       data-target="#interfaces-links"
                   >
                                   <span class="fa fa-info"></span>
                                   <span>Interfaces</span>
                                   <span class="fa fa-angle-down"></span>
                               </div>
                               <ul class="links collapse "
                                       id="interfaces-links"
                   >
                                       <li class="link">
                                           <a href="../interfaces/AbsolutePosition.html" >AbsolutePosition</a>
                                       </li>
                                       <li class="link">
                                           <a href="../interfaces/AlertModalData.html" >AlertModalData</a>
                                       </li>
                                       <li class="link">
                                           <a href="../interfaces/BannerContent.html" >BannerContent</a>
                                       </li>
                                       <li class="link">
                                           <a href="../interfaces/DialogConfig.html" >DialogConfig</a>
                                       </li>
                                       <li class="link">
                                           <a href="../interfaces/ListItem.html" >ListItem</a>
                                       </li>
                                       <li class="link">
                                           <a href="../interfaces/ModalButton.html" >ModalButton</a>
                                       </li>
                                       <li class="link">
                                           <a href="../interfaces/NotificationContent.html" >NotificationContent</a>
                                       </li>
                                       <li class="link">
                                           <a href="../interfaces/NotificationContent.html" >NotificationContent</a>
                                       </li>
                                       <li class="link">
                                           <a href="../interfaces/SampleInterface.html" >SampleInterface</a>
                                       </li>
                                       <li class="link">
                                           <a href="../interfaces/SizeMap.html" >SizeMap</a>
                                       </li>
                                       <li class="link">
                                           <a href="../interfaces/ToastContent.html" >ToastContent</a>
                                       </li>
                                       <li class="link">
                                           <a href="../interfaces/ToastContent.html" >ToastContent</a>
                                       </li>
                               </ul>
                           </li>
                   
                   
                           <li class="chapter">
                               <div class="simple menu-toggler" data-toggle="collapse"
                                       data-target="#miscellaneous-links"
                   >
                                   <span class="fa fa-cubes"></span>
                                   <span>Miscellaneous</span>
                                   <span class="fa fa-angle-down"></span>
                               </div>
                               <ul class="links collapse "
                                       id="miscellaneous-links"
                   >
                                       <li class="link">
                                         <a href="../miscellaneous/enumerations.html" data-type="entity-link" >Enums</a>
                                       </li>
                                       <li class="link">
                                         <a href="../miscellaneous/functions.html" data-type="entity-link" >Functions</a>
                                       </li>
                                       <li class="link">
                                         <a href="../miscellaneous/typealiases.html" data-type="entity-link" >Type aliases</a>
                                       </li>
                                       <li class="link">
                                         <a href="../miscellaneous/variables.html" data-type="entity-link" >Variables</a>
                                       </li>
                               </ul>
                           </li>
                   
                   
                           <li class="chapter">
                               <a data-type="chapter-link" href="../coverage.html" ><span class="fa fa-tasks"></span>Documentation coverage</a>
                           </li>
                   
                           <li class="divider"></li>
                           <li class="copyright">
                                   Documentation generated using <a href="https://compodoc.github.io/website/" target="_blank">
                                               <img src="..//images/compodoc-vectorise.svg" class="img-responsive">
                                   </a>
                           </li>
                   
                       </ul>
                   
                   </nav>
               </div>
               <div class="content component">
                   <div class="content-data">




<ol class="breadcrumb">
  <li>Components</li>
  <li>CalendarHeader</li>
</ol>

<ul class="nav nav-tabs" role="tablist">
    <li class="active">
        <a href="#info" id="info-tab" role="tab" data-toggle="tab" data-link="info">Info</a>
    </li>

    <li>
        <a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
    </li>

    <li>
        <a href="#tree" role="tab" id="tree-tab" data-toggle="tab" data-link="dom-tree">DOM Tree</a>
    </li>
</ul>

<div class="tab-content">
    <div class="tab-pane fade active in" id="info"><p class="comment">
    <h3>File</h3>
</p>
<p class="comment">
    <code>src/calendar/calendar-header.component.ts</code>
</p>





<section>
    <h3>Metadata</h3>
    <table class="table table-sm table-hover">
        <tbody>












            <tr>
                <td class="col-md-3">selector</td>
                <td class="col-md-9"><code>ibm-calendar-header</code></td>
            </tr>






        </tbody>
    </table>
</section>

    <section>
        <h3 id="index">Index</h3>
        <table class="table table-sm table-bordered index-table">
            <tbody>
                <tr>
                    <td class="col-md-4">
                        <h6><b>Methods</b></h6>
                    </td>
                </tr>
                <tr>
                    <td class="col-md-4">
                        <ul class="index-list">
                            <li>
                                 <a href="#getMonth">getMonth</a>
                            </li>
                            <li>
                                 <a href="#getYear">getYear</a>
                            </li>
                            <li>
                                 <a href="#nextMonth">nextMonth</a>
                            </li>
                            <li>
                                 <a href="#nextYear">nextYear</a>
                            </li>
                            <li>
                                 <a href="#previousMonth">previousMonth</a>
                            </li>
                            <li>
                                 <a href="#previousYear">previousYear</a>
                            </li>
                            <li>
                                 <a href="#range">range</a>
                            </li>
                        </ul>
                    </td>
                </tr>
                <tr>
                    <td class="col-md-4">
                        <h6><b>Inputs</b></h6>
                    </td>
                </tr>
                <tr>
                    <td class="col-md-4">
                        <ul class="index-list">
                            <li>
                                <a href="#currentView">currentView</a>
                            </li>
                            <li>
                                <a href="#header">header</a>
                            </li>
                            <li>
                                <a href="#monthCount">monthCount</a>
                            </li>
                        </ul>
                    </td>
                </tr>
            </tbody>
        </table>
    </section>


    <section>
        <h3 id="inputs">Inputs</h3>
            <table class="table table-sm table-bordered">
                <tbody>
                    <tr>
                        <td class="col-md-2">
                            <a name="currentView"></a>
                            <code>currentView</code>
                        </td>
                        <td class="col-md-10">
                              <p>
                                <em>Type:</em>    <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date" target="_blank" >Date</a></code>

                              </p>
                        </td>
                    </tr>
                            <tr>
                                <td class="col-md-2" colspan="2">
                                    <div class="io-line">Defined in <a href="" data-line="50" class="link-to-prism">src/calendar/calendar-header.component.ts:50</a></div>
                                </td>
                            </tr>
                </tbody>
            </table>
            <table class="table table-sm table-bordered">
                <tbody>
                    <tr>
                        <td class="col-md-2">
                            <a name="header"></a>
                            <code>header</code>
                        </td>
                        <td class="col-md-10">
                        </td>
                    </tr>
                            <tr>
                                <td class="col-md-2" colspan="2">
                                    <div class="io-line">Defined in <a href="" data-line="51" class="link-to-prism">src/calendar/calendar-header.component.ts:51</a></div>
                                </td>
                            </tr>
                </tbody>
            </table>
            <table class="table table-sm table-bordered">
                <tbody>
                    <tr>
                        <td class="col-md-2">
                            <a name="monthCount"></a>
                            <code>monthCount</code>
                        </td>
                        <td class="col-md-10">
                            <p>
                              <em>Default value: </em><code>1</code>
                            </p>
                        </td>
                    </tr>
                            <tr>
                                <td class="col-md-2" colspan="2">
                                    <div class="io-line">Defined in <a href="" data-line="52" class="link-to-prism">src/calendar/calendar-header.component.ts:52</a></div>
                                </td>
                            </tr>
                </tbody>
            </table>
    </section>




    <section>
        
            <h3 id="methods">
                Methods
            </h3>
            <table class="table table-sm table-bordered">
                <tbody>
                    <tr>
                        <td class="col-md-4">
                            <a name="getMonth"></a>
                            <span class="name"><b> getMonth</b><a href="#getMonth"><span class="fa fa-link"></span></a></span>
                        </td>
                    </tr>
                    <tr>
                        <td class="col-md-4">
    <code>getMonth(position: )</code>
                        </td>
                    </tr>
    
    
                            <tr>
                                <td class="col-md-4">
                                    <div class="io-line">Defined in <a href="" data-line="78" class="link-to-prism">src/calendar/calendar-header.component.ts:78</a></div>
                                </td>
                            </tr>
    
                    <tr>
                        <td class="col-md-4">
    
                                <div class="io-description">
                                        <b>Parameters :</b>
                                        <table class="params">
                                            <thead>
                                                <tr>
                                                    <td>Name</td>
                                                    <td>Type</td>
                                                    <td>Optional</td>
                                                    <td>Description</td>
                                                </tr>
                                            </thead>
                                            <tbody>
                                                    <tr>
                                                      <td>position</td>
                                                      <td>
                                                      </td>
                                                      <td>
                                                      </td>
                                                      <td></td>
                                                    </tr>
                                            </tbody>
                                        </table>
                                </div>
                                <div>
                                </div>
                                <div class="io-description">
                                    <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
    
                                </div>
                                    <div class="io-description">
                                        
                                    </div>
                        </td>
                    </tr>
                </tbody>
            </table>
            <table class="table table-sm table-bordered">
                <tbody>
                    <tr>
                        <td class="col-md-4">
                            <a name="getYear"></a>
                            <span class="name"><b> getYear</b><a href="#getYear"><span class="fa fa-link"></span></a></span>
                        </td>
                    </tr>
                    <tr>
                        <td class="col-md-4">
    <code>getYear()</code>
                        </td>
                    </tr>
    
    
                            <tr>
                                <td class="col-md-4">
                                    <div class="io-line">Defined in <a href="" data-line="74" class="link-to-prism">src/calendar/calendar-header.component.ts:74</a></div>
                                </td>
                            </tr>
    
                    <tr>
                        <td class="col-md-4">
    
                                <div class="io-description">
                                    <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
    
                                </div>
                        </td>
                    </tr>
                </tbody>
            </table>
            <table class="table table-sm table-bordered">
                <tbody>
                    <tr>
                        <td class="col-md-4">
                            <a name="nextMonth"></a>
                            <span class="name"><b> nextMonth</b><a href="#nextMonth"><span class="fa fa-link"></span></a></span>
                        </td>
                    </tr>
                    <tr>
                        <td class="col-md-4">
    <code>nextMonth()</code>
                        </td>
                    </tr>
    
    
                            <tr>
                                <td class="col-md-4">
                                    <div class="io-line">Defined in <a href="" data-line="62" class="link-to-prism">src/calendar/calendar-header.component.ts:62</a></div>
                                </td>
                            </tr>
    
                    <tr>
                        <td class="col-md-4">
    
                                <div class="io-description">
                                    <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
    
                                </div>
                        </td>
                    </tr>
                </tbody>
            </table>
            <table class="table table-sm table-bordered">
                <tbody>
                    <tr>
                        <td class="col-md-4">
                            <a name="nextYear"></a>
                            <span class="name"><b> nextYear</b><a href="#nextYear"><span class="fa fa-link"></span></a></span>
                        </td>
                    </tr>
                    <tr>
                        <td class="col-md-4">
    <code>nextYear()</code>
                        </td>
                    </tr>
    
    
                            <tr>
                                <td class="col-md-4">
                                    <div class="io-line">Defined in <a href="" data-line="58" class="link-to-prism">src/calendar/calendar-header.component.ts:58</a></div>
                                </td>
                            </tr>
    
                    <tr>
                        <td class="col-md-4">
    
                                <div class="io-description">
                                    <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
    
                                </div>
                        </td>
                    </tr>
                </tbody>
            </table>
            <table class="table table-sm table-bordered">
                <tbody>
                    <tr>
                        <td class="col-md-4">
                            <a name="previousMonth"></a>
                            <span class="name"><b> previousMonth</b><a href="#previousMonth"><span class="fa fa-link"></span></a></span>
                        </td>
                    </tr>
                    <tr>
                        <td class="col-md-4">
    <code>previousMonth()</code>
                        </td>
                    </tr>
    
    
                            <tr>
                                <td class="col-md-4">
                                    <div class="io-line">Defined in <a href="" data-line="70" class="link-to-prism">src/calendar/calendar-header.component.ts:70</a></div>
                                </td>
                            </tr>
    
                    <tr>
                        <td class="col-md-4">
    
                                <div class="io-description">
                                    <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
    
                                </div>
                        </td>
                    </tr>
                </tbody>
            </table>
            <table class="table table-sm table-bordered">
                <tbody>
                    <tr>
                        <td class="col-md-4">
                            <a name="previousYear"></a>
                            <span class="name"><b> previousYear</b><a href="#previousYear"><span class="fa fa-link"></span></a></span>
                        </td>
                    </tr>
                    <tr>
                        <td class="col-md-4">
    <code>previousYear()</code>
                        </td>
                    </tr>
    
    
                            <tr>
                                <td class="col-md-4">
                                    <div class="io-line">Defined in <a href="" data-line="66" class="link-to-prism">src/calendar/calendar-header.component.ts:66</a></div>
                                </td>
                            </tr>
    
                    <tr>
                        <td class="col-md-4">
    
                                <div class="io-description">
                                    <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
    
                                </div>
                        </td>
                    </tr>
                </tbody>
            </table>
            <table class="table table-sm table-bordered">
                <tbody>
                    <tr>
                        <td class="col-md-4">
                            <a name="range"></a>
                            <span class="name"><b> range</b><a href="#range"><span class="fa fa-link"></span></a></span>
                        </td>
                    </tr>
                    <tr>
                        <td class="col-md-4">
    <code>range(stop: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>, start: , step: )</code>
                        </td>
                    </tr>
    
    
                            <tr>
                                <td class="col-md-4">
                                    <div class="io-line">Defined in <a href="" data-line="54" class="link-to-prism">src/calendar/calendar-header.component.ts:54</a></div>
                                </td>
                            </tr>
    
                    <tr>
                        <td class="col-md-4">
    
                                <div class="io-description">
                                        <b>Parameters :</b>
                                        <table class="params">
                                            <thead>
                                                <tr>
                                                    <td>Name</td>
                                                    <td>Type</td>
                                                    <td>Optional</td>
                                                    <td>Description</td>
                                                </tr>
                                            </thead>
                                            <tbody>
                                                    <tr>
                                                      <td>stop</td>
                                                      <td>
                                                              <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
                                                      </td>
                                                      <td>
                                                      </td>
                                                      <td></td>
                                                    </tr>
                                                    <tr>
                                                      <td>start</td>
                                                      <td>
                                                      </td>
                                                      <td>
                                                      </td>
                                                      <td></td>
                                                    </tr>
                                                    <tr>
                                                      <td>step</td>
                                                      <td>
                                                      </td>
                                                      <td>
                                                      </td>
                                                      <td></td>
                                                    </tr>
                                            </tbody>
                                        </table>
                                </div>
                                <div>
                                </div>
                                <div class="io-description">
                                    <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
    
                                </div>
                                    <div class="io-description">
                                        
                                    </div>
                        </td>
                    </tr>
                </tbody>
            </table>
    </section>


</div>


    <div class="tab-pane fade tab-source-code" id="source">
        <pre class="line-numbers"><code class="language-typescript">import { Component, Input } from &quot;@angular/core&quot;;
import { DateTimeModel } from &quot;./date-time-model.class&quot;;
import { range } from &quot;../common/utils&quot;;

@Component({
	selector: &quot;ibm-calendar-header&quot;,
	template: &#x60;
			&lt;nav class&#x3D;&quot;pagination&quot; aria-label&#x3D;&quot;year-pagination&quot;&gt;
				&lt;ul&gt;
					&lt;li class&#x3D;&quot;pagination_chevron&quot;&gt;
						&lt;a (click)&#x3D;&quot;previousYear()&quot; title&#x3D;&quot;Previous page&quot; aria-label&#x3D;&quot;Previous page&quot;&gt;
							&lt;!-- &lt;peretz-icon set&#x3D;&quot;arrows_chevrons&quot; icon&#x3D;&quot;chevron_left&quot; size&#x3D;&quot;xs&quot;&gt;&lt;/peretz-icon&gt; --&gt;
						&lt;/a&gt;
					&lt;/li&gt;
					&lt;li *ngIf&#x3D;&quot;header &#x3D;&#x3D;&#x3D; &#x27;yearOnlyRange&#x27;&quot;&gt;{{getYear() - 5}} - {{getYear()}}&lt;/li&gt;
					&lt;li *ngIf&#x3D;&quot;header !&#x3D;&#x3D; &#x27;yearOnlyRange&#x27;&quot;&gt;{{getYear()}}&lt;/li&gt;
					&lt;li class&#x3D;&quot;pagination_chevron&quot;&gt;
						&lt;a (click)&#x3D;&quot;nextYear()&quot; title&#x3D;&quot;Next page&quot; aria-label&#x3D;&quot;Next page&quot;&gt;
							&lt;!-- &lt;peretz-icon set&#x3D;&quot;arrows_chevrons&quot; icon&#x3D;&quot;chevron_right&quot; size&#x3D;&quot;xs&quot;&gt;&lt;/peretz-icon&gt; --&gt;
						&lt;/a&gt;
					&lt;/li&gt;
				&lt;/ul&gt;
			&lt;/nav&gt;

			&lt;nav
			*ngIf&#x3D;&quot;header !&#x3D;&#x3D; &#x27;yearOnly&#x27; &amp;&amp; header !&#x3D;&#x3D; &#x27;yearOnlyRange&#x27;&quot;
			class&#x3D;&quot;pagination month&quot;
			aria-label&#x3D;&quot;month-pagination&quot;&gt;
				&lt;ul&gt;
					&lt;li class&#x3D;&quot;pagination_chevron&quot;&gt;
						&lt;a (click)&#x3D;&quot;previousMonth()&quot; title&#x3D;&quot;Previous page&quot; aria-label&#x3D;&quot;Previous page&quot;&gt;
							&lt;!-- &lt;peretz-icon set&#x3D;&quot;arrows_chevrons&quot; icon&#x3D;&quot;chevron_left&quot; size&#x3D;&quot;xs&quot;&gt;&lt;/peretz-icon&gt; --&gt;
						&lt;/a&gt;
					&lt;/li&gt;
					&lt;li
					class&#x3D;&quot;month_view-month&quot;
					*ngFor&#x3D;&quot;let month of range(monthCount)&quot;&gt;
						{{getMonth(month)}}
					&lt;/li&gt;
					&lt;li class&#x3D;&quot;pagination_chevron&quot;&gt;
						&lt;a (click)&#x3D;&quot;nextMonth()&quot; title&#x3D;&quot;Next page&quot; aria-label&#x3D;&quot;Next page&quot;&gt;
							&lt;!-- &lt;peretz-icon set&#x3D;&quot;arrows_chevrons&quot; icon&#x3D;&quot;chevron_right&quot; size&#x3D;&quot;xs&quot;&gt;&lt;/peretz-icon&gt; --&gt;
						&lt;/a&gt;
					&lt;/li&gt;
				&lt;/ul&gt;
			&lt;/nav&gt;
	&#x60;
})
export class CalendarHeader {
	@Input() currentView &#x3D; new Date();
	@Input() header;
	@Input() monthCount &#x3D; 1;

	range(stop: number, start &#x3D; 0, step &#x3D; 1) {
		return range(stop, start, step);
	}

	nextYear() {
		this.currentView.setFullYear(this.currentView.getFullYear() + 1);
	}

	nextMonth() {
		this.currentView.setMonth(this.currentView.getMonth() + 1);
	}

	previousYear() {
		this.currentView.setFullYear(this.currentView.getFullYear() - 1);
	}

	previousMonth() {
		this.currentView.setMonth(this.currentView.getMonth() - 1);
	}

	getYear() {
		return this.currentView.getFullYear();
	}

	getMonth(position &#x3D; 0) {
		const currentMonthInView &#x3D; (this.currentView.getMonth() + position) % 12;

		return DateTimeModel.monthsTranslateKeys[currentMonthInView];
	}
}
</code></pre>
    </div>


    <div class="tab-pane fade" id="tree">
        <div id="tree-container"></div>
        <div class="tree-legend">
            <div class="title">
                <b>Legend</b>
            </div>
            <div>
                <div class="color htmlelement"></div><span>Html element</span>
            </div>
            <div>
                <div class="color component"></div><span>Component</span>
            </div>
            <div>
                <div class="color directive"></div><span>Html element with directive</span>
            </div>
        </div>
    </div>
</div>

<script src="../js/libs/vis.min.js"></script>
<script src="../js/libs/htmlparser.js"></script>
<script src="../js/libs/deep-iterator.js"></script>
<script>
        var COMPONENT_TEMPLATE = '<div></div>'
    var COMPONENTS = [{'name': 'Accordion', 'selector': 'ibm-accordion'},{'name': 'AccordionItem', 'selector': 'ibm-accordion-item'},{'name': 'AlertModal', 'selector': 'ibm-alert-modal'},{'name': 'AlertModalStory', 'selector': 'app-alert-modal-story'},{'name': 'Banner', 'selector': 'ibm-banner'},{'name': 'Calendar', 'selector': 'ibm-calendar'},{'name': 'CalendarHeader', 'selector': 'ibm-calendar-header'},{'name': 'CalendarMonth', 'selector': 'ibm-calendar-month-view'},{'name': 'CalendarMonths', 'selector': 'ibm-calendar-months-view'},{'name': 'CalendarQuarter', 'selector': 'ibm-calendar-quarter-view'},{'name': 'CalendarYear', 'selector': 'ibm-calendar-year-view'},{'name': 'Checkbox', 'selector': 'ibm-checkbox'},{'name': 'ClickableTile', 'selector': 'ibm-clickable-tile'},{'name': 'CodeSnippet', 'selector': 'ibm-code-snippet'},{'name': 'ComboBox', 'selector': 'ibm-combo-box'},{'name': 'ContentSwitcher', 'selector': 'ibm-content-switcher'},{'name': 'Dialog', 'selector': 'ibm-dialog'},{'name': 'DialogPlaceholder', 'selector': 'ibm-dialog-placeholder'},{'name': 'Dropdown', 'selector': 'ibm-dropdown'},{'name': 'DropdownList', 'selector': 'ibm-dropdown-list'},{'name': 'DynamicTableStory', 'selector': 'app-custom-table'},{'name': 'ExpansionTableStory', 'selector': 'app-expansion-table'},{'name': 'Icon', 'selector': 'ibm-icon'},{'name': 'Label', 'selector': 'ibm-label'},{'name': 'ListGroup', 'selector': 'ibm-list-group'},{'name': 'Loading', 'selector': 'ibm-loading'},{'name': 'Modal', 'selector': 'ibm-modal'},{'name': 'ModalFooter', 'selector': 'ibm-modal-footer'},{'name': 'ModalHeader', 'selector': 'ibm-modal-header'},{'name': 'ModalPlaceholder', 'selector': 'ibm-modal-placeholder'},{'name': 'ModalStory', 'selector': 'app-modal-story'},{'name': 'Notification', 'selector': 'ibm-notification'},{'name': 'NotificationStory', 'selector': 'app-notification-story'},{'name': 'OverflowMenu', 'selector': 'ibm-overflow-menu'},{'name': 'OverflowMenuOption', 'selector': 'ibm-overflow-menu-option'},{'name': 'OverflowMenuPane', 'selector': 'ibm-overflow-menu-pane'},{'name': 'OverflowTableStory', 'selector': 'app-overflow-table'},{'name': 'Overlay', 'selector': 'ibm-overlay'},{'name': 'Pagination', 'selector': 'ibm-pagination'},{'name': 'PaginationStory', 'selector': 'app-pagination'},{'name': 'PaginationTableStory', 'selector': 'app-pagination-table'},{'name': 'Pill', 'selector': 'ibm-pill'},{'name': 'PillInput', 'selector': 'ibm-pill-input'},{'name': 'Placeholder', 'selector': 'ibm-placeholder'},{'name': 'ProgressIndicator', 'selector': 'ibm-progress-indicator'},{'name': 'Radio', 'selector': 'ibm-radio'},{'name': 'RadioGroup', 'selector': 'ibm-radio-group'},{'name': 'Sample', 'selector': 'ibm-sample'},{'name': 'SampleModal', 'selector': 'app-sample-modal'},{'name': 'SampleSub', 'selector': 'ibm-sample-sub'},{'name': 'Select', 'selector': 'ibm-select'},{'name': 'Sprite', 'selector': 'ibm-sprite'},{'name': 'StaticIcon', 'selector': 'ibm-static-icon'},{'name': 'Switch', 'selector': 'ibm-switch'},{'name': 'Tab', 'selector': 'ibm-tab'},{'name': 'TabHeaders', 'selector': 'ibm-tab-headers'},{'name': 'Table', 'selector': 'ibm-table'},{'name': 'TableStory', 'selector': 'app-table'},{'name': 'Tabs', 'selector': 'ibm-tabs'},{'name': 'Tile', 'selector': 'ibm-tile'},{'name': 'Toast', 'selector': 'ibm-toast'},{'name': 'Toast', 'selector': 'ibm-toast'},{'name': 'ToastStory', 'selector': 'app-toast-story'},{'name': 'Toggle', 'selector': 'ibm-toggle'},{'name': 'Tooltip', 'selector': 'ibm-tooltip'}];
    var DIRECTIVES = [{'name': 'Button', 'selector': '[ibmButton]'},{'name': 'ContentSwitcherOption', 'selector': '[ibmContentOption]'},{'name': 'DialogDirective', 'selector': '[ibmDialog]'},{'name': 'EllipsisTooltip', 'selector': '[ibmEllipsisTooltip]'},{'name': 'Link', 'selector': '[ibmLink]'},{'name': 'OptGroup', 'selector': 'optgroup'},{'name': 'Option', 'selector': 'option'},{'name': 'OverflowMenuDirective', 'selector': '[ibmOverflowMenu]'},{'name': 'ScrollableList', 'selector': '[ibmScrollableList]'},{'name': 'TextArea', 'selector': '[ibmTextArea]'},{'name': 'TextInput', 'selector': '[ibmText]'},{'name': 'TooltipDirective', 'selector': '[ibmTooltip]'}];
    var ACTUAL_COMPONENT = {'name': 'CalendarHeader'};
</script>
<script src="../js/tree.js"></script>










                   </div><div class="search-results">
    <div class="has-results">
        <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
        <ul class="search-results-list"></ul>
    </div>
    <div class="no-results">
        <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
    </div>
</div>
</div>
           </div>
       </div>

       <script src="../js/libs/bootstrap-native.js"></script>

       <script src="../js/libs/es6-shim.min.js"></script>
       <script src="../js/libs/EventDispatcher.js"></script>
       <script src="../js/libs/promise.min.js"></script>
       <script src="../js/libs/zepto.min.js"></script>

       <script src="../js/compodoc.js"></script>

       <script>var COMPODOC_CURRENT_PAGE_DEPTH = 1;</script>

       <script src="../js/search/search.js"></script>
       <script src="../js/search/lunr.min.js"></script>
       <script src="../js/search/search-lunr.js"></script>

       <script src="../js/tabs.js"></script>
       <script src="../js/menu.js"></script>
       <script src="../js/libs/prism.js"></script>
       <script src="../js/sourceCode.js"></script>
       <script src="../js/search/search_index.js"></script>

    </body>
</html>