@vivliostyle/core
Preparing search index...
page-floats
PageFloatLayoutStrategy
Interface PageFloatLayoutStrategy
interface
PageFloatLayoutStrategy
{
adjustPageFloatArea
(
floatArea
:
Layout
.
PageFloatArea
,
floatContainer
:
Vtree
.
Container
,
column
:
Layout
.
Column
,
)
:
any
;
appliesToFloat
(
float
:
PageFloats
.
PageFloat
)
:
boolean
;
appliesToNodeContext
(
nodeContext
:
Vtree
.
NodeContext
)
:
boolean
;
createPageFloat
(
nodeContext
:
Vtree
.
NodeContext
,
pageFloatLayoutContext
:
PageFloats
.
PageFloatLayoutContext
,
column
:
Layout
.
Column
,
)
:
Result
<
PageFloats
.
PageFloat
>
;
createPageFloatFragment
(
continuations
:
PageFloats
.
PageFloatContinuation
[]
,
floatSide
:
string
,
clearSide
:
string
,
floatArea
:
Layout
.
PageFloatArea
,
continues
:
boolean
,
)
:
PageFloats
.
PageFloatFragment
;
findPageFloatFragment
(
float
:
PageFloats
.
PageFloat
,
pageFloatLayoutContext
:
PageFloats
.
PageFloatLayoutContext
,
)
:
PageFloats
.
PageFloatFragment
;
forbid
(
float
:
PageFloats
.
PageFloat
,
pageFloatLayoutContext
:
PageFloats
.
PageFloatLayoutContext
,
)
:
any
;
}
Hierarchy (
View Summary
)
PageFloats
.
PageFloatLayoutStrategy
PageFloatLayoutStrategy
Implemented by
FootnoteLayoutStrategy
NormalPageFloatLayoutStrategy
Index
Methods
adjust
Page
Float
Area
applies
To
Float
applies
To
Node
Context
create
Page
Float
create
Page
Float
Fragment
find
Page
Float
Fragment
forbid
Methods
adjust
Page
Float
Area
adjustPageFloatArea
(
floatArea
:
Layout
.
PageFloatArea
,
floatContainer
:
Vtree
.
Container
,
column
:
Layout
.
Column
,
)
:
any
Parameters
floatArea
:
Layout
.
PageFloatArea
floatContainer
:
Vtree
.
Container
column
:
Layout
.
Column
Returns
any
applies
To
Float
appliesToFloat
(
float
:
PageFloats
.
PageFloat
)
:
boolean
Parameters
float
:
PageFloats
.
PageFloat
Returns
boolean
applies
To
Node
Context
appliesToNodeContext
(
nodeContext
:
Vtree
.
NodeContext
)
:
boolean
Parameters
nodeContext
:
Vtree
.
NodeContext
Returns
boolean
create
Page
Float
createPageFloat
(
nodeContext
:
Vtree
.
NodeContext
,
pageFloatLayoutContext
:
PageFloats
.
PageFloatLayoutContext
,
column
:
Layout
.
Column
,
)
:
Result
<
PageFloats
.
PageFloat
>
Parameters
nodeContext
:
Vtree
.
NodeContext
pageFloatLayoutContext
:
PageFloats
.
PageFloatLayoutContext
column
:
Layout
.
Column
Returns
Result
<
PageFloats
.
PageFloat
>
create
Page
Float
Fragment
createPageFloatFragment
(
continuations
:
PageFloats
.
PageFloatContinuation
[]
,
floatSide
:
string
,
clearSide
:
string
,
floatArea
:
Layout
.
PageFloatArea
,
continues
:
boolean
,
)
:
PageFloats
.
PageFloatFragment
Parameters
continuations
:
PageFloats
.
PageFloatContinuation
[]
floatSide
:
string
clearSide
:
string
floatArea
:
Layout
.
PageFloatArea
continues
:
boolean
Returns
PageFloats
.
PageFloatFragment
find
Page
Float
Fragment
findPageFloatFragment
(
float
:
PageFloats
.
PageFloat
,
pageFloatLayoutContext
:
PageFloats
.
PageFloatLayoutContext
,
)
:
PageFloats
.
PageFloatFragment
Parameters
float
:
PageFloats
.
PageFloat
pageFloatLayoutContext
:
PageFloats
.
PageFloatLayoutContext
Returns
PageFloats
.
PageFloatFragment
forbid
forbid
(
float
:
PageFloats
.
PageFloat
,
pageFloatLayoutContext
:
PageFloats
.
PageFloatLayoutContext
,
)
:
any
Parameters
float
:
PageFloats
.
PageFloat
pageFloatLayoutContext
:
PageFloats
.
PageFloatLayoutContext
Returns
any
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
adjust
Page
Float
Area
applies
To
Float
applies
To
Node
Context
create
Page
Float
create
Page
Float
Fragment
find
Page
Float
Fragment
forbid
@vivliostyle/core
Loading...