API / geotoolkit / widgets / legends / LegendLayout / LegendCssLayout
legends.LegendLayout.LegendCssLayout
Implements simple Legend layout (in absolute values) to layout LegendPanels
↳
LegendCssLayout
Constructors
- [new LegendCssLayout(referenceModel)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.widgets-1.legends.legendlayout.legendcsslayout.md#new legendcsslayout(referencemodel))
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
horizontalalignment | HorizontalAlignment | Horizontal alignment for Stacked Layout |
horizontalalignment | StackedAlignment | Horizontal alignment for Stacked Layout |
layoutmode | LayoutMode | Layout mode, free or stacked |
verticalalignment | VerticalAlignment | Vertical alignment for Stacked Layout |
verticalalignment | StackedAlignment | Vertical alignment for Stacked Layout |
Constructors
• new LegendCssLayout(referenceModel?)
CssLayout.constructor
Methods
▸ add(item): LegendCssLayout
Adds layoutable element
| Name | Type | Description |
|---|---|---|
item | ILayoutable | ILayoutable[] | Iterator<ILayoutable> | layoutable element(s) |
▸ calculateLayoutStyle(node, model, nodeDeviceRect): Options<string | number>
| Name | Type |
|---|---|
node | Node & ILayoutable |
model | Group<Node> |
nodeDeviceRect | Rect |
Options<string | number>
▸ clear(): LegendCssLayout
Remove all children items from layout
▸ clone(): LegendCssLayout
All subclasses should override copyConstructor or provide custom implementation for this method
▸ Protected copyConstructor(src, deepCopy?): LegendCssLayout
Copy constructor function.<br> Function used as part of the cloning mechanism.<br> Implementations should copy the given instance state to this instance.<br>
| Name | Type | Description |
|---|---|---|
src | LegendCssLayout | Source to copy from |
Optional deepCopy | boolean |
▸ dispose(): void
Dispose.
void
▸ Protected getBounds(modelLimits, layoutStyle, node?): Rect
| Name | Type | Description |
|---|---|---|
modelLimits | Rect | model limits |
layoutStyle | LayoutStyle<string | number> | layout style |
Optional node | ILayoutable | node |
▸ getClassName(): string
string
▸ getHorizontalAlignment(): HorizontalAlignment | StackedAlignment
HorizontalAlignment | StackedAlignment
▸ getIterator(targets?): Iterator<ILayoutable>
| Name | Type | Description |
|---|---|---|
Optional targets | ILayoutable[] | Iterator<ILayoutable> | optional, items for iterator |
Iterator<ILayoutable>
▸ getLayoutMode(): LayoutMode
▸ Protected getLayoutStyle(current): LayoutStyle<string | number>
get node layout style
| Name | Type |
|---|---|
current | ILayoutable |
LayoutStyle<string | number>
▸ getPreferredSize(rect, targets?): Rect
Return the preferable size of children. Default implementation returns desired rect
| Name | Type | Description |
|---|---|---|
rect | Rect | desired rect to layout |
Optional targets | ILayoutable[] | Iterator<ILayoutable> | array of nodes supposed to layout |
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
properties An object containing the properties of the layout
▸ getReferenceModel(): Group<Node>
▸ getVerticalAlignment(): VerticalAlignment | StackedAlignment
VerticalAlignment | StackedAlignment
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
▸ insert(index, item): LegendCssLayout
Inserts layoutable element
| Name | Type | Description |
|---|---|---|
index | number | index where element will be inserted |
item | ILayoutable | ILayoutable[] | Iterator<ILayoutable> | layoutable element(s) |
▸ invalidateLayout(): LegendCssLayout
Notify that layout is invalidated. Send event Events.LayoutInvalidated
this
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ layout(rect, targets): LegendCssLayout
Performs layout operation
| Name | Type | Description |
|---|---|---|
rect | Rect | desired rect to layout |
targets | ILayoutable[] | array of nodes or iterator of nodes supposed to layout |
this
▸ Protected layoutItems(rect, items): LegendCssLayout
| Name | Type |
|---|---|
rect | Rect |
items | ILayoutable[] | Iterator<ILayoutable> |
▸ notify<E>(type, source, args?): LegendCssLayout
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | Layout | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): LegendCssLayout
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: LegendCssLayout, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): LegendCssLayout
Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target. </p>
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: LegendCssLayout, args: EventMap[E]) => void | to be called |
this
▸ remove(item): LegendCssLayout
Removes a layoutable node if found
| Name | Type | Description |
|---|---|---|
item | ILayoutable | layoutable element |
▸ setHorizontalAlignment(alignment): LegendCssLayout
| Name | Type |
|---|---|
alignment | HorizontalAlignment | StackedAlignment |
▸ setLayoutMode(mode): LegendCssLayout
| Name | Type |
|---|---|
mode | LayoutMode |
▸ setProperties(properties): LegendCssLayout
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
properties | Options | An object containing the properties to set |
this
▸ setSilent(bool): LegendCssLayout
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setVerticalAlignment(alignment): LegendCssLayout
| Name | Type |
|---|---|
alignment | VerticalAlignment | StackedAlignment |
▸ Static getClassName(): string
string
▸ Static getDefault(): CssLayout
Return Default CSS Layout