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 > Layout | 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 ="layout.html "> Layout</ a > 60</ li > 61</ ul > 62< h1 > Class Layout</ 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< a href ="layoutrefmut.html "class ="tsd-signature-type "> LayoutRefMut</ a > 82< ul class ="tsd-hierarchy "> 83< li > 84< span class ="target "> Layout</ span > 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 tsd-is-inherited "> 95< h3 > Constructors</ h3 > 96< ul class ="tsd-index-list "> 97< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< a href ="layout.html#constructor "class ="tsd-kind-icon "> constructor</ a ></ li > 98</ ul > 99</ section > 100< section class ="tsd-index-section tsd-is-inherited "> 101< h3 > Properties</ h3 > 102< ul class ="tsd-index-list "> 103< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< a href ="layout.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 tsd-is-inherited ">< a href ="layout.html#clone "class ="tsd-kind-icon "> clone</ a ></ li > 110< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="layout.html#dispose "class ="tsd-kind-icon "> dispose</ a ></ li > 111< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< a href ="layout.html#push "class ="tsd-kind-icon "> push</ a ></ li > 112< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< a href ="layout.html#remount "class ="tsd-kind-icon "> remount</ a ></ li > 113< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< a href ="layout.html#scrolldown "class ="tsd-kind-icon "> scroll< wbr > Down</ a ></ li > 114< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< a href ="layout.html#scrollup "class ="tsd-kind-icon "> scroll< wbr > Up</ a ></ li > 115< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< a href ="layout.html#settingsasjson "class ="tsd-kind-icon "> settings< wbr > AsJson</ a ></ li > 116< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< a href ="layout.html#stateasjson "class ="tsd-kind-icon "> state< wbr > AsJson</ a ></ li > 117< li class ="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter ">< a href ="layout.html#with "class ="tsd-kind-icon "> with</ a ></ li > 118< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-static ">< a href ="layout.html#defaultlayout "class ="tsd-kind-icon "> default< wbr > Layout</ a ></ li > 119< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-static ">< a href ="layout.html#new "class ="tsd-kind-icon "> new</ a ></ li > 120< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-static ">< a href ="layout.html#parsejson "class ="tsd-kind-icon "> parse< wbr > Json</ a ></ li > 121</ ul > 122</ section > 123</ div > 124</ section > 125</ section > 126< section class ="tsd-panel-group tsd-member-group tsd-is-inherited "> 127< h2 > Constructors</ h2 > 128< section class ="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited "> 129< a name ="constructor "class ="tsd-anchor "></ a > 130< h3 > constructor</ h3 > 131< ul class ="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited "> 132< li class ="tsd-signature tsd-kind-icon "> new< wbr > Layout< 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 ="layout.html "class ="tsd-signature-type "> Layout</ a ></ li > 133</ ul > 134< ul class ="tsd-descriptions "> 135< li class ="tsd-description "> 136< aside class ="tsd-sources "> 137< p > Inherited from< a href ="layoutref.html "> LayoutRef</ a > .< a href ="layoutref.html#constructor "> constructor</ a ></ p > 138< ul > 139< li > Defined in livesplit_core.ts:3011</ li > 140</ ul > 141</ aside > 142< div class ="tsd-comment tsd-typography "> 143< div class ="lead "> 144< p > This constructor is an implementation detail. Do not use this.</ p > 145</ div > 146</ div > 147< h4 class ="tsd-parameters-title "> Parameters</ h4 > 148< ul class ="tsd-parameters "> 149< li > 150< h5 > ptr:< span class ="tsd-signature-type "> number</ span ></ h5 > 151</ li > 152</ ul > 153< h4 class ="tsd-returns-title "> Returns< a href ="layout.html "class ="tsd-signature-type "> Layout</ a ></ h4 > 154</ li > 155</ ul > 156</ section > 157</ section > 158< section class ="tsd-panel-group tsd-member-group tsd-is-inherited "> 159< h2 > Properties</ h2 > 160< section class ="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited "> 161< a name ="ptr "class ="tsd-anchor "></ a > 162< h3 > ptr</ h3 > 163< div class ="tsd-signature tsd-kind-icon "> ptr< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-type "> number</ span ></ div > 164< aside class ="tsd-sources "> 165< p > Inherited from< a href ="layoutref.html "> LayoutRef</ a > .< a href ="layoutref.html#ptr "> ptr</ a ></ p > 166< ul > 167< li > Defined in livesplit_core.ts:2991</ li > 168</ ul > 169</ aside > 170</ section > 171</ section > 172< section class ="tsd-panel-group tsd-member-group "> 173< h2 > Methods</ h2 > 174< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 175< a name ="clone "class ="tsd-anchor "></ a > 176< h3 > clone</ h3 > 177< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 178< 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 > 179</ ul > 180< ul class ="tsd-descriptions "> 181< li class ="tsd-description "> 182< aside class ="tsd-sources "> 183< p > Inherited from< a href ="layoutref.html "> LayoutRef</ a > .< a href ="layoutref.html#clone "> clone</ a ></ p > 184< ul > 185< li > Defined in livesplit_core.ts:2995</ li > 186</ ul > 187</ aside > 188< div class ="tsd-comment tsd-typography "> 189< div class ="lead "> 190< p > Clones the layout.</ p > 191</ div > 192</ div > 193< h4 class ="tsd-returns-title "> Returns< a href ="layout.html "class ="tsd-signature-type "> Layout</ a ></ h4 > 194</ li > 195</ ul > 196</ section > 197< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 198< a name ="dispose "class ="tsd-anchor "></ a > 199< h3 > dispose</ h3 > 200< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 201< li class ="tsd-signature tsd-kind-icon "> dispose< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> void</ span ></ li > 202</ ul > 203< ul class ="tsd-descriptions "> 204< li class ="tsd-description "> 205< aside class ="tsd-sources "> 206< ul > 207< li > Defined in livesplit_core.ts:3107</ li > 208</ ul > 209</ aside > 210< div class ="tsd-comment tsd-typography "> 211< div class ="lead "> 212< p > Disposes the object, allowing it to clean up all of its memory. You need 213 to call this for every object that you don't use anymore and hasn't 214 already been disposed.</ p > 215</ div > 216</ div > 217< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> void</ span ></ h4 > 218</ li > 219</ ul > 220</ section > 221< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 222< a name ="push "class ="tsd-anchor "></ a > 223< h3 > push</ h3 > 224< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 225< li class ="tsd-signature tsd-kind-icon "> push< span class ="tsd-signature-symbol "> (</ span > component< span class ="tsd-signature-symbol "> :</ span >< a href ="component.html "class ="tsd-signature-type "> Component</ a >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> void</ span ></ li > 226</ ul > 227< ul class ="tsd-descriptions "> 228< li class ="tsd-description "> 229< aside class ="tsd-sources "> 230< p > Inherited from< a href ="layoutrefmut.html "> LayoutRefMut</ a > .< a href ="layoutrefmut.html#push "> push</ a ></ p > 231< ul > 232< li > Defined in livesplit_core.ts:3042</ li > 233</ ul > 234</ aside > 235< div class ="tsd-comment tsd-typography "> 236< div class ="lead "> 237< p > Adds a new component to the end of the layout.</ p > 238</ div > 239</ div > 240< h4 class ="tsd-parameters-title "> Parameters</ h4 > 241< ul class ="tsd-parameters "> 242< li > 243< h5 > component:< a href ="component.html "class ="tsd-signature-type "> Component</ a ></ h5 > 244</ li > 245</ ul > 246< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> void</ span ></ h4 > 247</ li > 248</ ul > 249</ section > 250< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 251< a name ="remount "class ="tsd-anchor "></ a > 252< h3 > remount</ h3 > 253< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 254< li class ="tsd-signature tsd-kind-icon "> remount< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> void</ span ></ li > 255</ ul > 256< ul class ="tsd-descriptions "> 257< li class ="tsd-description "> 258< aside class ="tsd-sources "> 259< p > Inherited from< a href ="layoutrefmut.html "> LayoutRefMut</ a > .< a href ="layoutrefmut.html#remount "> remount</ a ></ p > 260< ul > 261< li > Defined in livesplit_core.ts:3076</ li > 262</ ul > 263</ aside > 264< div class ="tsd-comment tsd-typography "> 265< div class ="lead "> 266< p > Remounts all the components as if they were freshly initialized. Some 267 components may only provide some information whenever it changes or when 268 their state is first queried. Remounting returns this information again, 269 whenever the layout's state is queried the next time.</ p > 270</ div > 271</ div > 272< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> void</ span ></ h4 > 273</ li > 274</ ul > 275</ section > 276< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 277< a name ="scrolldown "class ="tsd-anchor "></ a > 278< h3 > scroll< wbr > Down</ h3 > 279< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 280< li class ="tsd-signature tsd-kind-icon "> scroll< wbr > Down< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> void</ span ></ li > 281</ ul > 282< ul class ="tsd-descriptions "> 283< li class ="tsd-description "> 284< aside class ="tsd-sources "> 285< p > Inherited from< a href ="layoutrefmut.html "> LayoutRefMut</ a > .< a href ="layoutrefmut.html#scrolldown "> scrollDown</ a ></ p > 286< ul > 287< li > Defined in livesplit_core.ts:3064</ li > 288</ ul > 289</ aside > 290< div class ="tsd-comment tsd-typography "> 291< div class ="lead "> 292< p > Scrolls down all the components in the layout that can be scrolled down.</ p > 293</ div > 294</ div > 295< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> void</ span ></ h4 > 296</ li > 297</ ul > 298</ section > 299< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 300< a name ="scrollup "class ="tsd-anchor "></ a > 301< h3 > scroll< wbr > Up</ h3 > 302< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 303< li class ="tsd-signature tsd-kind-icon "> scroll< wbr > Up< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> void</ span ></ li > 304</ ul > 305< ul class ="tsd-descriptions "> 306< li class ="tsd-description "> 307< aside class ="tsd-sources "> 308< p > Inherited from< a href ="layoutrefmut.html "> LayoutRefMut</ a > .< a href ="layoutrefmut.html#scrollup "> scrollUp</ a ></ p > 309< ul > 310< li > Defined in livesplit_core.ts:3055</ li > 311</ ul > 312</ aside > 313< div class ="tsd-comment tsd-typography "> 314< div class ="lead "> 315< p > Scrolls up all the components in the layout that can be scrolled up.</ p > 316</ div > 317</ div > 318< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> void</ span ></ h4 > 319</ li > 320</ ul > 321</ section > 322< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 323< a name ="settingsasjson "class ="tsd-anchor "></ a > 324< h3 > settings< wbr > AsJson</ h3 > 325< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 326< 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 > 327</ ul > 328< ul class ="tsd-descriptions "> 329< li class ="tsd-description "> 330< aside class ="tsd-sources "> 331< p > Inherited from< a href ="layoutref.html "> LayoutRef</ a > .< a href ="layoutref.html#settingsasjson "> settingsAsJson</ a ></ p > 332< ul > 333< li > Defined in livesplit_core.ts:3005</ li > 334</ ul > 335</ aside > 336< div class ="tsd-comment tsd-typography "> 337< div class ="lead "> 338< p > Encodes the settings of the layout as JSON.</ p > 339</ div > 340</ div > 341< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> any</ span ></ h4 > 342</ li > 343</ ul > 344</ section > 345< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 346< a name ="stateasjson "class ="tsd-anchor "></ a > 347< h3 > state< wbr > AsJson</ h3 > 348< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 349< li class ="tsd-signature tsd-kind-icon "> state< wbr > AsJson< span class ="tsd-signature-symbol "> (</ span > timer< span class ="tsd-signature-symbol "> :</ span >< a href ="timerref.html "class ="tsd-signature-type "> TimerRef</ a >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> any</ span ></ li > 350</ ul > 351< ul class ="tsd-descriptions "> 352< li class ="tsd-description "> 353< aside class ="tsd-sources "> 354< p > Inherited from< a href ="layoutrefmut.html "> LayoutRefMut</ a > .< a href ="layoutrefmut.html#stateasjson "> stateAsJson</ a ></ p > 355< ul > 356< li > Defined in livesplit_core.ts:3029</ li > 357</ ul > 358</ aside > 359< div class ="tsd-comment tsd-typography "> 360< div class ="lead "> 361< p > Calculates the layout's state based on the timer provided and encodes it as 362 JSON. You can use this to visualize all of the components of a layout.</ p > 363</ div > 364</ div > 365< h4 class ="tsd-parameters-title "> Parameters</ h4 > 366< ul class ="tsd-parameters "> 367< li > 368< h5 > timer:< a href ="timerref.html "class ="tsd-signature-type "> TimerRef</ a ></ h5 > 369</ li > 370</ ul > 371< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> any</ span ></ h4 > 372</ li > 373</ ul > 374</ section > 375< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter "> 376< a name ="with "class ="tsd-anchor "></ a > 377< h3 > with</ h3 > 378< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter "> 379< li class ="tsd-signature tsd-kind-icon "> with<T>< span class ="tsd-signature-symbol "> (</ span > closure< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> function</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> T</ span ></ li > 380</ ul > 381< ul class ="tsd-descriptions "> 382< li class ="tsd-description "> 383< aside class ="tsd-sources "> 384< ul > 385< li > Defined in livesplit_core.ts:3095</ li > 386</ ul > 387</ aside > 388< div class ="tsd-comment tsd-typography "> 389< div class ="lead "> 390< p > Allows for scoped usage of the object. The object is guaranteed to get 391 disposed once this function returns. You are free to dispose the object 392 early yourself anywhere within the scope. The scope's return value gets 393 carried to the outside of this function.</ p > 394</ div > 395</ div > 396< h4 class ="tsd-type-parameters-title "> Type parameters</ h4 > 397< ul class ="tsd-type-parameters "> 398< li > 399< h4 > T</ h4 > 400</ li > 401</ ul > 402< h4 class ="tsd-parameters-title "> Parameters</ h4 > 403< ul class ="tsd-parameters "> 404< li > 405< h5 > closure:< span class ="tsd-signature-type "> function</ span ></ h5 > 406< ul class ="tsd-parameters "> 407< li class ="tsd-parameter-siganture "> 408< ul class ="tsd-signatures tsd-kind-type-literal tsd-is-not-exported "> 409< li class ="tsd-signature tsd-kind-icon ">< span class ="tsd-signature-symbol "> (</ span > obj< span class ="tsd-signature-symbol "> :</ span >< a href ="layout.html "class ="tsd-signature-type "> Layout</ a >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> T</ span ></ li > 410</ ul > 411< ul class ="tsd-descriptions "> 412< li class ="tsd-description "> 413< h4 class ="tsd-parameters-title "> Parameters</ h4 > 414< ul class ="tsd-parameters "> 415< li > 416< h5 > obj:< a href ="layout.html "class ="tsd-signature-type "> Layout</ a ></ h5 > 417</ li > 418</ ul > 419< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> T</ span ></ h4 > 420</ li > 421</ ul > 422</ li > 423</ ul > 424</ li > 425</ ul > 426< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> T</ span ></ h4 > 427</ li > 428</ ul > 429</ section > 430< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static "> 431< a name ="defaultlayout "class ="tsd-anchor "></ a > 432< h3 >< span class ="tsd-flag ts-flagStatic "> Static</ span > default< wbr > Layout</ h3 > 433< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static "> 434< li class ="tsd-signature tsd-kind-icon "> default< wbr > Layout< 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 > 435</ ul > 436< ul class ="tsd-descriptions "> 437< li class ="tsd-description "> 438< aside class ="tsd-sources "> 439< ul > 440< li > Defined in livesplit_core.ts:3126</ li > 441</ ul > 442</ aside > 443< div class ="tsd-comment tsd-typography "> 444< div class ="lead "> 445< p > Creates a new default layout that contains a default set of components 446 in order to provide a good default layout for runners. Which components 447 are provided by this and how they are configured may change in the 448 future.</ p > 449</ div > 450</ div > 451< h4 class ="tsd-returns-title "> Returns< a href ="layout.html "class ="tsd-signature-type "> Layout</ a ></ h4 > 452</ li > 453</ ul > 454</ section > 455< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static "> 456< a name ="new "class ="tsd-anchor "></ a > 457< h3 >< span class ="tsd-flag ts-flagStatic "> Static</ span > new</ h3 > 458< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static "> 459< li class ="tsd-signature tsd-kind-icon "> new< 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 > 460</ ul > 461< ul class ="tsd-descriptions "> 462< li class ="tsd-description "> 463< aside class ="tsd-sources "> 464< ul > 465< li > Defined in livesplit_core.ts:3116</ li > 466</ ul > 467</ aside > 468< div class ="tsd-comment tsd-typography "> 469< div class ="lead "> 470< p > Creates a new empty layout with no components.</ p > 471</ div > 472</ div > 473< h4 class ="tsd-returns-title "> Returns< a href ="layout.html "class ="tsd-signature-type "> Layout</ a ></ h4 > 474</ li > 475</ ul > 476</ section > 477< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static "> 478< a name ="parsejson "class ="tsd-anchor "></ a > 479< h3 >< span class ="tsd-flag ts-flagStatic "> Static</ span > parse< wbr > Json</ h3 > 480< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static "> 481< li class ="tsd-signature tsd-kind-icon "> parse< wbr > Json< span class ="tsd-signature-symbol "> (</ span > settings< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> any</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="layout.html "class ="tsd-signature-type "> Layout</ a >< span class ="tsd-signature-symbol "> |</ span >< span class ="tsd-signature-type "> null</ span ></ li > 482</ ul > 483< ul class ="tsd-descriptions "> 484< li class ="tsd-description "> 485< aside class ="tsd-sources "> 486< ul > 487< li > Defined in livesplit_core.ts:3134</ li > 488</ ul > 489</ aside > 490< div class ="tsd-comment tsd-typography "> 491< div class ="lead "> 492< p > Parses a layout from the given JSON description of its settings. null is 493 returned if it couldn't be parsed.</ p > 494</ div > 495</ div > 496< h4 class ="tsd-parameters-title "> Parameters</ h4 > 497< ul class ="tsd-parameters "> 498< li > 499< h5 > settings:< span class ="tsd-signature-type "> any</ span ></ h5 > 500</ li > 501</ ul > 502< h4 class ="tsd-returns-title "> Returns< a href ="layout.html "class ="tsd-signature-type "> Layout</ a > 503< span class ="tsd-signature-symbol "> |</ span > 504< span class ="tsd-signature-type "> null</ span > 505</ h4 > 506</ li > 507</ ul > 508</ section > 509</ section > 510</ div > 511< div class ="col-4 col-menu menu-sticky-wrap menu-highlight "> 512< nav class ="tsd-navigation primary "> 513< ul > 514< li class ="globals "> 515< a href ="../globals.html ">< em > Globals</ em ></ a > 516</ li > 517</ ul > 518</ nav > 519< nav class ="tsd-navigation secondary menu-sticky "> 520< ul class ="before-current "> 521</ ul > 522< ul class ="current "> 523< li class ="current tsd-kind-class "> 524< a href ="layout.html "class ="tsd-kind-icon "> Layout</ a > 525< ul > 526< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited "> 527< a href ="layout.html#constructor "class ="tsd-kind-icon "> constructor</ a > 528</ li > 529< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited "> 530< a href ="layout.html#ptr "class ="tsd-kind-icon "> ptr</ a > 531</ li > 532< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 533< a href ="layout.html#clone "class ="tsd-kind-icon "> clone</ a > 534</ li > 535< li class ="tsd-kind-method tsd-parent-kind-class "> 536< a href ="layout.html#dispose "class ="tsd-kind-icon "> dispose</ a > 537</ li > 538< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 539< a href ="layout.html#push "class ="tsd-kind-icon "> push</ a > 540</ li > 541< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 542< a href ="layout.html#remount "class ="tsd-kind-icon "> remount</ a > 543</ li > 544< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 545< a href ="layout.html#scrolldown "class ="tsd-kind-icon "> scroll< wbr > Down</ a > 546</ li > 547< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 548< a href ="layout.html#scrollup "class ="tsd-kind-icon "> scroll< wbr > Up</ a > 549</ li > 550< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 551< a href ="layout.html#settingsasjson "class ="tsd-kind-icon "> settings< wbr > AsJson</ a > 552</ li > 553< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 554< a href ="layout.html#stateasjson "class ="tsd-kind-icon "> state< wbr > AsJson</ a > 555</ li > 556< li class ="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter "> 557< a href ="layout.html#with "class ="tsd-kind-icon "> with</ a > 558</ li > 559< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-static "> 560< a href ="layout.html#defaultlayout "class ="tsd-kind-icon "> default< wbr > Layout</ a > 561</ li > 562< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-static "> 563< a href ="layout.html#new "class ="tsd-kind-icon "> new</ a > 564</ li > 565< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-static "> 566< a href ="layout.html#parsejson "class ="tsd-kind-icon "> parse< wbr > Json</ a > 567</ li > 568</ ul > 569</ li > 570</ ul > 571< ul class ="after-current "> 572</ ul > 573</ nav > 574</ div > 575</ div > 576</ div > 577< footer class ="with-border-bottom "> 578< div class ="container "> 579< h2 > Legend</ h2 > 580< div class ="tsd-legend-group "> 581< ul class ="tsd-legend "> 582< li class ="tsd-kind-module ">< span class ="tsd-kind-icon "> Module</ span ></ li > 583< li class ="tsd-kind-object-literal ">< span class ="tsd-kind-icon "> Object literal</ span ></ li > 584< li class ="tsd-kind-variable ">< span class ="tsd-kind-icon "> Variable</ span ></ li > 585< li class ="tsd-kind-function ">< span class ="tsd-kind-icon "> Function</ span ></ li > 586< li class ="tsd-kind-function tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Function with type parameter</ span ></ li > 587< li class ="tsd-kind-index-signature ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 588< li class ="tsd-kind-type-alias ">< span class ="tsd-kind-icon "> Type alias</ span ></ li > 589</ ul > 590< ul class ="tsd-legend "> 591< li class ="tsd-kind-enum ">< span class ="tsd-kind-icon "> Enumeration</ span ></ li > 592< li class ="tsd-kind-enum-member ">< span class ="tsd-kind-icon "> Enumeration member</ span ></ li > 593< li class ="tsd-kind-property tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Property</ span ></ li > 594< li class ="tsd-kind-method tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Method</ span ></ li > 595</ ul > 596< ul class ="tsd-legend "> 597< li class ="tsd-kind-interface ">< span class ="tsd-kind-icon "> Interface</ span ></ li > 598< li class ="tsd-kind-interface tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Interface with type parameter</ span ></ li > 599< li class ="tsd-kind-constructor tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 600< li class ="tsd-kind-property tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Property</ span ></ li > 601< li class ="tsd-kind-method tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Method</ span ></ li > 602< li class ="tsd-kind-index-signature tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 603</ ul > 604< ul class ="tsd-legend "> 605< li class ="tsd-kind-class ">< span class ="tsd-kind-icon "> Class</ span ></ li > 606< li class ="tsd-kind-class tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Class with type parameter</ span ></ li > 607< li class ="tsd-kind-constructor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 608< li class ="tsd-kind-property tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Property</ span ></ li > 609< li class ="tsd-kind-method tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Method</ span ></ li > 610< li class ="tsd-kind-accessor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Accessor</ span ></ li > 611< li class ="tsd-kind-index-signature tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 612</ ul > 613< ul class ="tsd-legend "> 614< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited constructor</ span ></ li > 615< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited property</ span ></ li > 616< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited method</ span ></ li > 617< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited accessor</ span ></ li > 618</ ul > 619< ul class ="tsd-legend "> 620< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected property</ span ></ li > 621< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected method</ span ></ li > 622< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected accessor</ span ></ li > 623</ ul > 624< ul class ="tsd-legend "> 625< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private property</ span ></ li > 626< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private method</ span ></ li > 627< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private accessor</ span ></ li > 628</ ul > 629< ul class ="tsd-legend "> 630< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static property</ span ></ li > 631< li class ="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static method</ span ></ li > 632</ ul > 633</ div > 634</ div > 635</ footer > 636< div class ="container tsd-generator "> 637< p > Generated using< a href ="http://typedoc.org/ "target ="_blank "> TypeDoc</ a ></ p > 638</ div > 639< div class ="overlay "></ div > 640< script src ="../assets/js/main.js "></ script > 641< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' );</ script > 642</ body > 643</ html >