Xivgear Types Documentation
Preparing search index...
@xivgear/core
persistence/saved_sheets
SheetManager
Interface SheetManager
interface
SheetManager
{
allDisplayableSheets
:
PublicOnly
<
SheetHandleImpl
>
[]
;
allSheets
:
PublicOnly
<
SheetHandleImpl
>
[]
;
afterSheetListChange
()
:
void
;
afterSheetUpdate
(
handle
:
SheetHandle
)
:
void
;
flush
()
:
void
;
getByKey
(
sheetKey
:
string
)
:
PublicOnly
<
SheetHandleImpl
>
;
getNextSheetInternalName
()
:
string
;
getNextSheetNumber
()
:
number
;
getOrCreateForKey
(
key
:
string
)
:
SheetHandle
;
newSheetFromRemote
(
saveKey
:
string
,
remoteVersion
:
number
,
summary
:
SheetSummary
,
)
:
SheetHandle
;
newSheetFromScratch
(
summary
:
SheetSummary
)
:
SheetHandle
;
reorderTo
(
draggedSheet
:
SheetHandle
,
draggedTo
:
SheetHandle
)
:
"up"
|
"down"
;
resetAll
()
:
void
;
resort
()
:
void
;
saveAs
(
sheet
:
SheetExport
)
:
string
;
saveData
(
sheet
:
GearPlanSheet
)
:
void
;
setAsyncLoader
(
loader
:
SheetAsyncLoader
)
:
void
;
setUpdateHook
(
key
:
string
,
hook
:
SyncUpdateHook
)
:
void
;
syncLastSheetNumber
(
numFromServer
:
number
)
:
void
;
}
Implemented by
SheetManagerImpl
Index
Properties
all
Displayable
Sheets
all
Sheets
Methods
after
Sheet
List
Change
after
Sheet
Update
flush
get
By
Key
get
Next
Sheet
Internal
Name
get
Next
Sheet
Number
get
Or
Create
For
Key
new
Sheet
From
Remote
new
Sheet
From
Scratch
reorder
To
reset
All
resort
save
As
save
Data
set
Async
Loader
set
Update
Hook
sync
Last
Sheet
Number
Properties
Readonly
all
Displayable
Sheets
allDisplayableSheets
:
PublicOnly
<
SheetHandleImpl
>
[]
Readonly
all
Sheets
allSheets
:
PublicOnly
<
SheetHandleImpl
>
[]
Methods
after
Sheet
List
Change
afterSheetListChange
()
:
void
Returns
void
after
Sheet
Update
afterSheetUpdate
(
handle
:
SheetHandle
)
:
void
Parameters
handle
:
SheetHandle
Returns
void
flush
flush
()
:
void
Returns
void
get
By
Key
getByKey
(
sheetKey
:
string
)
:
PublicOnly
<
SheetHandleImpl
>
Parameters
sheetKey
:
string
Returns
PublicOnly
<
SheetHandleImpl
>
get
Next
Sheet
Internal
Name
getNextSheetInternalName
()
:
string
Returns
string
get
Next
Sheet
Number
getNextSheetNumber
()
:
number
Returns
number
get
Or
Create
For
Key
getOrCreateForKey
(
key
:
string
)
:
SheetHandle
Parameters
key
:
string
Returns
SheetHandle
new
Sheet
From
Remote
newSheetFromRemote
(
saveKey
:
string
,
remoteVersion
:
number
,
summary
:
SheetSummary
,
)
:
SheetHandle
Parameters
saveKey
:
string
remoteVersion
:
number
summary
:
SheetSummary
Returns
SheetHandle
new
Sheet
From
Scratch
newSheetFromScratch
(
summary
:
SheetSummary
)
:
SheetHandle
Parameters
summary
:
SheetSummary
Returns
SheetHandle
reorder
To
reorderTo
(
draggedSheet
:
SheetHandle
,
draggedTo
:
SheetHandle
)
:
"up"
|
"down"
Parameters
draggedSheet
:
SheetHandle
draggedTo
:
SheetHandle
Returns
"up"
|
"down"
reset
All
resetAll
()
:
void
Debug method which will reset the sort order of all sheets
Returns
void
resort
resort
()
:
void
Returns
void
save
As
saveAs
(
sheet
:
SheetExport
)
:
string
Parameters
sheet
:
SheetExport
Returns
string
save
Data
saveData
(
sheet
:
GearPlanSheet
)
:
void
Parameters
sheet
:
GearPlanSheet
Returns
void
set
Async
Loader
setAsyncLoader
(
loader
:
SheetAsyncLoader
)
:
void
Parameters
loader
:
SheetAsyncLoader
Returns
void
set
Update
Hook
setUpdateHook
(
key
:
string
,
hook
:
SyncUpdateHook
)
:
void
Parameters
key
:
string
hook
:
SyncUpdateHook
Returns
void
sync
Last
Sheet
Number
syncLastSheetNumber
(
numFromServer
:
number
)
:
void
Parameters
numFromServer
:
number
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
all
Displayable
Sheets
all
Sheets
Methods
after
Sheet
List
Change
after
Sheet
Update
flush
get
By
Key
get
Next
Sheet
Internal
Name
get
Next
Sheet
Number
get
Or
Create
For
Key
new
Sheet
From
Remote
new
Sheet
From
Scratch
reorder
To
reset
All
resort
save
As
save
Data
set
Async
Loader
set
Update
Hook
sync
Last
Sheet
Number
Xivgear Types Documentation
Loading...
Debug method which will reset the sort order of all sheets