TextBox

TextBox is a layer that contains text that is flowed into the designated frame, breaking lines as needed.

Topics

Properties
- Identification
- Geometry
- Transformations
- Frame
- Shadow
- Filters
- Text
- Font
- Point Size
- Alignment
Animation
Sublayers
Superlayers
Hit Testing
CoreAnimation
Attributed String

Discussion

Properties

Refer to the properties concepts section for an overview of properties.

`setPropertiesByName`(properties, **kwargs)	Set the value of multiple properties by name.
`setPropertyByName`(name, value, **kwargs)	Set property `name` with `value`.
`propertyGroup`([name, duration, timing, …])	Create a context manager that allows setting multiple properties in an efficient way.

Identification

`getName`([makeIfNeeded])	Get the name assigned to this layer during `__init__`.
`setInfoValue`(key, value)	Set `key : value` in this layer’s info dictionary.
`getInfoValue`(key[, fallback])	Set `key` from the arbitrary info dictionary.

Geometry

Refer to the geometry concepts section for an overview of geometry.

`getAnchor`()	Get the anchor of the layer.
`setAnchor`(value)	Set the anchor of the layer.
`getPosition`()	Get the position of this layer.
`setPosition`(position)	Set the position of this layer.
`getSize`()	Get the size of this layer.
`setSize`(size)	Set the Size of this layer.

Transformations

`getTransformations`()	Get a list of all transformations.
`addTransformation`(transformation, name[, center])	Add a transformation with `name` that applies to this layer and all of its sublayers.
`removeTransformation`(name)	Remove the transformation with `name`.
`addTranslationTransformation`(value[, name])	Add a translate transformation with `name`.
`addScaleTransformation`(value[, name, center])	Add a scale transformation with `name` and `center`.
`addRotationTransformation`(value[, name, center])	Add a rotation transformation with `name` and `center`.
`addSkewTransformation`(value[, name, center])	Add a skew transformation with `name` and `center`.
`addSublayerTransformation`(transformation, name)	Add a transformation with `name` that applies to all of this layer’s sublayers.
`removeSublayerTransformation`(name)	Remove the transformation with `name`.
`addSublayerTranslationTransformation`(value)	Add a sublayer translate transformation with `name`.
`addSublayerScaleTransformation`(value[, …])	Add a sublayer scale transformation with `name` and `center`.
`addSublayerRotationTransformation`(value[, …])	Add a sublayer scale transformation with `name` and `center`.
`addSublayerSkewTransformation`(value[, name, …])	Add a sublayer skew transformation with `name` and `center`.

Frame

`getVisible`()	Get if the layer is visible.
`setVisible`(value)	Set if the layer is visible.
`getMaskToFrame`()	Get if the layer hides any sublayer data outside of its frame.
`setMaskToFrame`(value)	set if the layer hides any sublayer data outside of its frame.
`getOpacity`()	Get the opacity of this layer.
`setOpacity`(value)	Set the opacity of this layer,
`getBackgroundColor`()	Get the background color for this layer.
`setBackgroundColor`(color)	Set the background color for this layer.
`getBorderColor`()	Get the border color for this layer.
`setBorderColor`(color)	Set the border color for this layer.
`getBorderWidth`()	Get the border width for this layer.
`setBorderWidth`(value)	Set the border width for this layer.
`getCornerRadius`()	Get this corner radius of this layer.
`setCornerRadius`(value)	Set the corner radius of this layer.

TextBox.getPadding(): Get the padding for this layer.

TextBox.setPadding(value)

Set the padding between the edge of the frame and the text for this layer. padding should be a tuple of two numbers representing horizontal and vertical values.

textBoxLayer = container.appendTextBoxSublayer(
   position=(50, 50),
   size=(400, 100),
   backgroundColor=(1, 1, 0, 1),
   text="Merz " * 28,
   pointSize=10,
   fillColor=(1, 0, 0, 1)
)

textBoxLayer.setPadding((100, 25))

Shadow

`getShadowColor`()	Get the shadow color for this layer.
`setShadowColor`(color)	Set the shadow color for this layer.
`getShadowOpacity`()	Get the shadow opacity for this layer.
`setShadowOpacity`(value)	Set the shadow opacity for this layer.
`getShadowOffset`()	Get the shadow offset for this layer.
`setShadowOffset`(offset)	Set the shadow offset for this layer.
`getShadowBlurRadius`()	Get the shadow blur radius for this layer.
`setShadowBlurRadius`(value)	Set the shadow blur radius for this layer.

Filters

Refer the filter documentation in Base for complete details.

`getCompositingMode`()	Set the compositing filter for the layer.
`setCompositingMode`(filterType)	Set the compositing filter for the layer.
`getFilters`()	Get a list of the filters for this layer.
`setFilters`(allFilterSettings)	Set a list of the filters for this layer.
`appendFilter`(filterSettings)	Append a filter to this layer.
`getFilter`(name)	Get the filter with `name` from this layer.
`removeFilter`(name)	Remove the filter with `name` from this layer.
`clearFilters`()	Clear all background filters from this layer.
`getBackgroundFilters`()	Get a list of the background filters for this layer.
`setBackgroundFilters`(allFilterSettings)	Set a list of the background filters for this layer.
`appendBackgroundFilter`(filterSettings)	Append a background filter to this layer.
`getBackgroundFilter`(name)	Get the background filter with `name` from this layer.
`removeBackgroundFilter`(name)	Remove the background filter with `name` from this layer.

Text

TextBox.getText(): Get the text for this layer.

TextBox.setText(text)

Set the text for this layer. text can be either a string or an Attributed String.

textBoxLayer = container.appendTextBoxSublayer(
   position=(50, 50),
   size=(400, 100),
   backgroundColor=(1, 1, 0, 1),
   fillColor=(1, 0, 0, 1)
)

textBoxLayer.setText("Merz")

textBoxLayer = container.appendTextBoxSublayer(
       position=(50, 50),
       size=(400, 100),
       backgroundColor=(1, 1, 0, 1),
       pointSize=30,
       fillColor=(1, 0, 0, 1)
    )

    textBoxLayer.setText(
        [
            dict(
                text="Merz ",
                weight="black"
            ),
            dict(
                text="Merz ",
                font="Courier",
                pointSize=20,
                fillColor=(0, 0, 1, 1)
            ),
            "Merz " * 5
        ]
    )

TextBox.getFillColor(): Get the fill color for this layer.

TextBox.setFillColor(color)

Set the fill color for this layer.

Animatable.

textBoxLayer = container.appendTextBoxSublayer(
   position=(50, 50),
   size=(400, 100),
   text="Merz",
   backgroundColor=(1, 1, 0, 1)
)

textBoxLayer.setFillColor((0, 0, 1, 1))

Font

TextBox.getFont(): Get the name of the font for this layer.

TextBox.setFont(name)

Set the name of the font for this layer. If the name is "system" the system font will be used.

textBoxLayer = container.appendTextBoxSublayer(
   position=(50, 50),
   size=(400, 100),
   text="Merz",
   backgroundColor=(1, 1, 0, 1),
   fillColor=(1, 0, 0, 1)
)

textBoxLayer.setFont("Courier")

TextBox.getWeight(): Get the weight of the font in the layer.

TextBox.setWeight(value)

Set the weight of the font in the layer. This only applies to system fonts. The options are:

"thin"
"ultralight"
"light"
"regular"
"medium"
"semibold"
"bold"
"heavy"
"black"

textBoxLayer = container.appendTextBoxSublayer(
   position=(50, 50),
   size=(400, 100),
   text="Merz",
   backgroundColor=(1, 1, 0, 1),
   fillColor=(1, 0, 0, 1)
)

textBoxLayer.setWeight("black")

TextBox.getFigureStyle(): Get the figure style.

TextBox.setFigureStyle(value)

Set the figure style. This only applies to system fonts. The options are:

"regular"
"tabular"

textBoxLayer = container.appendTextBoxSublayer(
   position=(50, 50),
   size=(400, 100),
   text="0123456789",
   fillColor=(1, 0, 0, 1),
   backgroundColor=(1, 1, 0, 1)
)

textBoxLayer.setFigureStyle("tabular")

Point Size

TextBox.getPointSize(): Get the point size for this layer.

TextBox.setPointSize(value)

Set the point size for this layer.

Animatable.

textBoxLayer = container.appendTextBoxSublayer(
   position=(50, 50),
   size=(400, 100),
   backgroundColor=(1, 1, 0, 1),
   text="Merz " * 50,
   fillColor=(1, 0, 0, 1)
)

textBoxLayer.setPointSize(15)

TextBox.getPointSizeIsVisuallyConstant(): Get if the point size for this layer should always visually be the value of pointSize.

TextBox.setPointSizeIsVisuallyConstant(value): Set if the point size for this layer should always visually be the value of pointSize.

Alignment

TextBox.getHorizontalAlignment(): Get the horizontal alignment for this layer.

TextBox.setHorizontalAlignment(value)

Set the horizontal alignment for this layer. The options are:

"left"
"right"
"center"

textBoxLayer = container.appendTextBoxSublayer(
   position=(50, 50),
   size=(400, 100),
   text="Merz",
   fillColor=(1, 0, 0, 1),
   backgroundColor=(1, 1, 0, 1)
)

textBoxLayer.setHorizontalAlignment("right")

Animation

Refer to the animation concepts section for an overview of animation.

`clearAnimation`()	Remove all animations from this layer.
`stopAnimation`(name)	Stop the animation with the `name` given when the animation was created with a property group.
`isAnimationPaused`()	Get if animation is currently paused for this layer.
`pauseAnimation`()	Pause the animation of this layer.
`resumeAnimation`()	Resume the animation of the layer.

Sublayers

Refer to the layer hierarchy concepts section for an overview of sublayers.

`sublayerGroup`([sublayers])	Place a hold on adding the sublayers to this layer’s CALayer until the context manager exits.
`getSublayers`()	Get all sublayers within this layer.
`getSublayer`(name)	Get the sublayer with `name`.
`clearSublayers`()	Remove all sublayers within this layer.
`removeSublayer`(sublayer)	Remove the given sublayer from the layer.
`appendSublayer`(sublayer)	Append an instantiated sublayer to this layer.
`appendSublayerOfClass`(layerClass, **kwargs)	Append a sublayer to this layer.
`appendBaseSublayer`(**kwargs)	Append a base layer.
`appendPathSublayer`(**kwargs)	Append a path layer.
`appendLineSublayer`(**kwargs)	Append a line layer.
`appendOvalSublayer`(**kwargs)	Append a oval layer.
`appendRectangleSublayer`(**kwargs)	Append a rectangle layer.
`appendImageSublayer`(**kwargs)	Append an image layer.
`appendTextBoxSublayer`(**kwargs)	Append a text box.
`appendTextLineSublayer`(**kwargs)	Append a text line.
`appendSymbolSublayer`(**kwargs)	Append a symbol.
`drawingTools`([clear])	This creates a context manager that provides a sublayer creation syntax that supports a subset of the DrawBot API.

Superlayers

Refer to the layer hierarchy concepts section for an overview of superlayers.

`getContainer`()	Get the Container that this layer belongs to.
`getSuperlayer`()	Get the layer that this layer belongs to.

Hit Testing

CoreAnimation Object

getCALayer()

Get the CALayer that this object wraps.