fork/livesplit-core
git clone https://git.julia.blue/fork/livesplit-core
ee16b86
v0.11.0
1<!doctype html > 2< html class ="default no-js "> 3< head > 4< meta charset ="utf-8 "> 5< meta http-equiv ="X-UA-Compatible "content ="IE=edge "> 6< title > LayoutRef | livesplit</ title > 7< meta name ="description "content =""> 8< meta name ="viewport "content ="width=device-width, initial-scale=1 "> 9< link rel ="stylesheet "href ="../assets/css/main.css "> 10</ head > 11< body > 12< header > 13< div class ="tsd-page-toolbar "> 14< div class ="container "> 15< div class ="table-wrap "> 16< div class ="table-cell "id ="tsd-search "data-index ="../assets/js/search.js "data-base =".. "> 17< div class ="field "> 18< label for ="tsd-search-field "class ="tsd-widget search no-caption "> Search</ label > 19< input id ="tsd-search-field "type ="text "/> 20</ div > 21< ul class ="results "> 22< li class ="state loading "> Preparing search index...</ li > 23< li class ="state failure "> The search index is not available</ li > 24</ ul > 25< a href ="../index.html "class ="title "> livesplit</ a > 26</ div > 27< div class ="table-cell "id ="tsd-widgets "> 28< div id ="tsd-filter "> 29< a href ="# "class ="tsd-widget options no-caption "data-toggle ="options "> Options</ a > 30< div class ="tsd-filter-group "> 31< div class ="tsd-select "id ="tsd-filter-visibility "> 32< span class ="tsd-select-label "> All</ span > 33< ul class ="tsd-select-list "> 34< li data-value ="public "> Public</ li > 35< li data-value ="protected "> Public/Protected</ li > 36< li data-value ="private "class ="selected "> All</ li > 37</ ul > 38</ div > 39< input type ="checkbox "id ="tsd-filter-inherited "checked /> 40< label class ="tsd-widget "for ="tsd-filter-inherited "> Inherited</ label > 41< input type ="checkbox "id ="tsd-filter-externals "checked /> 42< label class ="tsd-widget "for ="tsd-filter-externals "> Externals</ label > 43< input type ="checkbox "id ="tsd-filter-only-exported "/> 44< label class ="tsd-widget "for ="tsd-filter-only-exported "> Only exported</ label > 45</ div > 46</ div > 47< a href ="# "class ="tsd-widget menu no-caption "data-toggle ="menu "> Menu</ a > 48</ div > 49</ div > 50</ div > 51</ div > 52< div class ="tsd-page-title "> 53< div class ="container "> 54< ul class ="tsd-breadcrumb "> 55< li > 56< a href ="../globals.html "> Globals</ a > 57</ li > 58< li > 59< a href ="layoutref.html "> LayoutRef</ a > 60</ li > 61</ ul > 62< h1 > Class LayoutRef</ h1 > 63</ div > 64</ div > 65</ header > 66< div class ="container container-main "> 67< div class ="row "> 68< div class ="col-8 col-content "> 69< section class ="tsd-panel tsd-comment "> 70< div class ="tsd-comment tsd-typography "> 71< div class ="lead "> 72< p > A Layout allows you to combine multiple components together to visualize a 73 variety of information the runner is interested in.</ p > 74</ div > 75</ div > 76</ section > 77< section class ="tsd-panel tsd-hierarchy "> 78< h3 > Hierarchy</ h3 > 79< ul class ="tsd-hierarchy "> 80< li > 81< span class ="target "> LayoutRef</ span > 82< ul class ="tsd-hierarchy "> 83< li > 84< a href ="layoutrefmut.html "class ="tsd-signature-type "> LayoutRefMut</ a > 85</ li > 86</ ul > 87</ li > 88</ ul > 89</ section > 90< section class ="tsd-panel-group tsd-index-group "> 91< h2 > Index</ h2 > 92< section class ="tsd-panel tsd-index-panel "> 93< div class ="tsd-index-content "> 94< section class ="tsd-index-section "> 95< h3 > Constructors</ h3 > 96< ul class ="tsd-index-list "> 97< li class ="tsd-kind-constructor tsd-parent-kind-class ">< a href ="layoutref.html#constructor "class ="tsd-kind-icon "> constructor</ a ></ li > 98</ ul > 99</ section > 100< section class ="tsd-index-section "> 101< h3 > Properties</ h3 > 102< ul class ="tsd-index-list "> 103< li class ="tsd-kind-property tsd-parent-kind-class ">< a href ="layoutref.html#ptr "class ="tsd-kind-icon "> ptr</ a ></ li > 104</ ul > 105</ section > 106< section class ="tsd-index-section "> 107< h3 > Methods</ h3 > 108< ul class ="tsd-index-list "> 109< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="layoutref.html#clone "class ="tsd-kind-icon "> clone</ a ></ li > 110< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="layoutref.html#settingsasjson "class ="tsd-kind-icon "> settings< wbr > AsJson</ a ></ li > 111</ ul > 112</ section > 113</ div > 114</ section > 115</ section > 116< section class ="tsd-panel-group tsd-member-group "> 117< h2 > Constructors</ h2 > 118< section class ="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class "> 119< a name ="constructor "class ="tsd-anchor "></ a > 120< h3 > constructor</ h3 > 121< ul class ="tsd-signatures tsd-kind-constructor tsd-parent-kind-class "> 122< li class ="tsd-signature tsd-kind-icon "> new< wbr > Layout< wbr > Ref< span class ="tsd-signature-symbol "> (</ span > ptr< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> number</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="layoutref.html "class ="tsd-signature-type "> LayoutRef</ a ></ li > 123</ ul > 124< ul class ="tsd-descriptions "> 125< li class ="tsd-description "> 126< aside class ="tsd-sources "> 127< ul > 128< li > Defined in livesplit_core.ts:3011</ li > 129</ ul > 130</ aside > 131< div class ="tsd-comment tsd-typography "> 132< div class ="lead "> 133< p > This constructor is an implementation detail. Do not use this.</ p > 134</ div > 135</ div > 136< h4 class ="tsd-parameters-title "> Parameters</ h4 > 137< ul class ="tsd-parameters "> 138< li > 139< h5 > ptr:< span class ="tsd-signature-type "> number</ span ></ h5 > 140</ li > 141</ ul > 142< h4 class ="tsd-returns-title "> Returns< a href ="layoutref.html "class ="tsd-signature-type "> LayoutRef</ a ></ h4 > 143</ li > 144</ ul > 145</ section > 146</ section > 147< section class ="tsd-panel-group tsd-member-group "> 148< h2 > Properties</ h2 > 149< section class ="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class "> 150< a name ="ptr "class ="tsd-anchor "></ a > 151< h3 > ptr</ h3 > 152< div class ="tsd-signature tsd-kind-icon "> ptr< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-type "> number</ span ></ div > 153< aside class ="tsd-sources "> 154< ul > 155< li > Defined in livesplit_core.ts:2991</ li > 156</ ul > 157</ aside > 158</ section > 159</ section > 160< section class ="tsd-panel-group tsd-member-group "> 161< h2 > Methods</ h2 > 162< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 163< a name ="clone "class ="tsd-anchor "></ a > 164< h3 > clone</ h3 > 165< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 166< li class ="tsd-signature tsd-kind-icon "> clone< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="layout.html "class ="tsd-signature-type "> Layout</ a ></ li > 167</ ul > 168< ul class ="tsd-descriptions "> 169< li class ="tsd-description "> 170< aside class ="tsd-sources "> 171< ul > 172< li > Defined in livesplit_core.ts:2995</ li > 173</ ul > 174</ aside > 175< div class ="tsd-comment tsd-typography "> 176< div class ="lead "> 177< p > Clones the layout.</ p > 178</ div > 179</ div > 180< h4 class ="tsd-returns-title "> Returns< a href ="layout.html "class ="tsd-signature-type "> Layout</ a ></ h4 > 181</ li > 182</ ul > 183</ section > 184< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 185< a name ="settingsasjson "class ="tsd-anchor "></ a > 186< h3 > settings< wbr > AsJson</ h3 > 187< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 188< li class ="tsd-signature tsd-kind-icon "> settings< wbr > AsJson< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> any</ span ></ li > 189</ ul > 190< ul class ="tsd-descriptions "> 191< li class ="tsd-description "> 192< aside class ="tsd-sources "> 193< ul > 194< li > Defined in livesplit_core.ts:3005</ li > 195</ ul > 196</ aside > 197< div class ="tsd-comment tsd-typography "> 198< div class ="lead "> 199< p > Encodes the settings of the layout as JSON.</ p > 200</ div > 201</ div > 202< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> any</ span ></ h4 > 203</ li > 204</ ul > 205</ section > 206</ section > 207</ div > 208< div class ="col-4 col-menu menu-sticky-wrap menu-highlight "> 209< nav class ="tsd-navigation primary "> 210< ul > 211< li class ="globals "> 212< a href ="../globals.html ">< em > Globals</ em ></ a > 213</ li > 214</ ul > 215</ nav > 216< nav class ="tsd-navigation secondary menu-sticky "> 217< ul class ="before-current "> 218</ ul > 219< ul class ="current "> 220< li class ="current tsd-kind-class "> 221< a href ="layoutref.html "class ="tsd-kind-icon "> Layout< wbr > Ref</ a > 222< ul > 223< li class ="tsd-kind-constructor tsd-parent-kind-class "> 224< a href ="layoutref.html#constructor "class ="tsd-kind-icon "> constructor</ a > 225</ li > 226< li class ="tsd-kind-property tsd-parent-kind-class "> 227< a href ="layoutref.html#ptr "class ="tsd-kind-icon "> ptr</ a > 228</ li > 229< li class ="tsd-kind-method tsd-parent-kind-class "> 230< a href ="layoutref.html#clone "class ="tsd-kind-icon "> clone</ a > 231</ li > 232< li class ="tsd-kind-method tsd-parent-kind-class "> 233< a href ="layoutref.html#settingsasjson "class ="tsd-kind-icon "> settings< wbr > AsJson</ a > 234</ li > 235</ ul > 236</ li > 237</ ul > 238< ul class ="after-current "> 239</ ul > 240</ nav > 241</ div > 242</ div > 243</ div > 244< footer class ="with-border-bottom "> 245< div class ="container "> 246< h2 > Legend</ h2 > 247< div class ="tsd-legend-group "> 248< ul class ="tsd-legend "> 249< li class ="tsd-kind-module ">< span class ="tsd-kind-icon "> Module</ span ></ li > 250< li class ="tsd-kind-object-literal ">< span class ="tsd-kind-icon "> Object literal</ span ></ li > 251< li class ="tsd-kind-variable ">< span class ="tsd-kind-icon "> Variable</ span ></ li > 252< li class ="tsd-kind-function ">< span class ="tsd-kind-icon "> Function</ span ></ li > 253< li class ="tsd-kind-function tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Function with type parameter</ span ></ li > 254< li class ="tsd-kind-index-signature ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 255< li class ="tsd-kind-type-alias ">< span class ="tsd-kind-icon "> Type alias</ span ></ li > 256</ ul > 257< ul class ="tsd-legend "> 258< li class ="tsd-kind-enum ">< span class ="tsd-kind-icon "> Enumeration</ span ></ li > 259< li class ="tsd-kind-enum-member ">< span class ="tsd-kind-icon "> Enumeration member</ span ></ li > 260< li class ="tsd-kind-property tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Property</ span ></ li > 261< li class ="tsd-kind-method tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Method</ span ></ li > 262</ ul > 263< ul class ="tsd-legend "> 264< li class ="tsd-kind-interface ">< span class ="tsd-kind-icon "> Interface</ span ></ li > 265< li class ="tsd-kind-interface tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Interface with type parameter</ span ></ li > 266< li class ="tsd-kind-constructor tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 267< li class ="tsd-kind-property tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Property</ span ></ li > 268< li class ="tsd-kind-method tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Method</ span ></ li > 269< li class ="tsd-kind-index-signature tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 270</ ul > 271< ul class ="tsd-legend "> 272< li class ="tsd-kind-class ">< span class ="tsd-kind-icon "> Class</ span ></ li > 273< li class ="tsd-kind-class tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Class with type parameter</ span ></ li > 274< li class ="tsd-kind-constructor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 275< li class ="tsd-kind-property tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Property</ span ></ li > 276< li class ="tsd-kind-method tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Method</ span ></ li > 277< li class ="tsd-kind-accessor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Accessor</ span ></ li > 278< li class ="tsd-kind-index-signature tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 279</ ul > 280< ul class ="tsd-legend "> 281< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited constructor</ span ></ li > 282< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited property</ span ></ li > 283< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited method</ span ></ li > 284< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited accessor</ span ></ li > 285</ ul > 286< ul class ="tsd-legend "> 287< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected property</ span ></ li > 288< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected method</ span ></ li > 289< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected accessor</ span ></ li > 290</ ul > 291< ul class ="tsd-legend "> 292< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private property</ span ></ li > 293< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private method</ span ></ li > 294< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private accessor</ span ></ li > 295</ ul > 296< ul class ="tsd-legend "> 297< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static property</ span ></ li > 298< li class ="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static method</ span ></ li > 299</ ul > 300</ div > 301</ div > 302</ footer > 303< div class ="container tsd-generator "> 304< p > Generated using< a href ="http://typedoc.org/ "target ="_blank "> TypeDoc</ a ></ p > 305</ div > 306< div class ="overlay "></ div > 307< script src ="../assets/js/main.js "></ script > 308< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' );</ script > 309</ body > 310</ html >