rubyXL 3.3.29 → 3.4.33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/.circleci/config.yml +60 -0
- data/.rubocop.yml +124 -0
- data/CHANGELOG.md +12 -0
- data/Gemfile +11 -8
- data/LICENSE.txt +1 -1
- data/README.rdoc +57 -19
- data/Rakefile +29 -29
- data/VERSION +1 -1
- data/lib/rubyXL/cell.rb +2 -29
- data/lib/rubyXL/convenience_methods/cell.rb +276 -0
- data/lib/rubyXL/convenience_methods/color.rb +156 -0
- data/lib/rubyXL/convenience_methods/font.rb +63 -0
- data/lib/rubyXL/convenience_methods/workbook.rb +137 -0
- data/lib/rubyXL/convenience_methods/worksheet.rb +734 -0
- data/lib/rubyXL/convenience_methods.rb +5 -1122
- data/lib/rubyXL/objects/border.rb +0 -3
- data/lib/rubyXL/objects/calculation_chain.rb +2 -2
- data/lib/rubyXL/objects/cell_style.rb +4 -6
- data/lib/rubyXL/objects/chartsheet.rb +8 -12
- data/lib/rubyXL/objects/color.rb +4 -6
- data/lib/rubyXL/objects/column_range.rb +16 -15
- data/lib/rubyXL/objects/comments.rb +1 -4
- data/lib/rubyXL/objects/connection.rb +175 -0
- data/lib/rubyXL/objects/container_nodes.rb +1 -5
- data/lib/rubyXL/objects/content_types.rb +3 -6
- data/lib/rubyXL/objects/data_validation.rb +2 -2
- data/lib/rubyXL/objects/document_properties.rb +12 -15
- data/lib/rubyXL/objects/extensions.rb +0 -2
- data/lib/rubyXL/objects/external_links.rb +38 -8
- data/lib/rubyXL/objects/fill.rb +2 -5
- data/lib/rubyXL/objects/filters.rb +5 -7
- data/lib/rubyXL/objects/font.rb +2 -7
- data/lib/rubyXL/objects/formula.rb +3 -5
- data/lib/rubyXL/objects/ooxml_object.rb +40 -31
- data/lib/rubyXL/objects/query_table.rb +106 -0
- data/lib/rubyXL/objects/reference.rb +26 -17
- data/lib/rubyXL/objects/relationships.rb +14 -14
- data/lib/rubyXL/objects/root.rb +0 -2
- data/lib/rubyXL/objects/shared_strings.rb +4 -7
- data/lib/rubyXL/objects/sheet_common.rb +1 -3
- data/lib/rubyXL/objects/sheet_data.rb +44 -17
- data/lib/rubyXL/objects/simple_types.rb +19 -2
- data/lib/rubyXL/objects/storage.rb +60 -49
- data/lib/rubyXL/objects/stylesheet.rb +9 -17
- data/lib/rubyXL/objects/text.rb +6 -8
- data/lib/rubyXL/objects/theme.rb +23 -9
- data/lib/rubyXL/objects/workbook.rb +144 -36
- data/lib/rubyXL/objects/worksheet.rb +48 -34
- data/lib/rubyXL/parser.rb +1 -3
- data/lib/rubyXL/worksheet.rb +86 -86
- data/lib/rubyXL.rb +1 -1
- data/rdoc/README_rdoc.html +212 -153
- data/rdoc/RubyXL/AExtension.html +33 -69
- data/rdoc/RubyXL/AExtensionStorageArea.html +12 -18
- data/rdoc/RubyXL/ActiveX.html +26 -52
- data/rdoc/RubyXL/ActiveXBinary.html +12 -23
- data/rdoc/RubyXL/AdjustHandleList.html +13 -20
- data/rdoc/RubyXL/Alignment.html +13 -20
- data/rdoc/RubyXL/AlternateContent.html +12 -18
- data/rdoc/RubyXL/AlternateUrls.html +99 -0
- data/rdoc/RubyXL/Authors.html +13 -20
- data/rdoc/RubyXL/AutoFilter.html +13 -20
- data/rdoc/RubyXL/AutoFilterColumn.html +13 -20
- data/rdoc/RubyXL/BinaryImageFile.html +12 -26
- data/rdoc/RubyXL/BodyProperties.html +13 -20
- data/rdoc/RubyXL/BooleanNode.html +12 -18
- data/rdoc/RubyXL/BooleanValue.html +12 -18
- data/rdoc/RubyXL/Border.html +49 -101
- data/rdoc/RubyXL/BorderEdge.html +32 -61
- data/rdoc/RubyXL/Borders.html +25 -44
- data/rdoc/RubyXL/Break.html +13 -20
- data/rdoc/RubyXL/BreakList.html +13 -20
- data/rdoc/RubyXL/CT_AdjPoint2D.html +13 -20
- data/rdoc/RubyXL/CT_AlphaBiLevelEffect.html +13 -20
- data/rdoc/RubyXL/CT_AlphaModulateEffect.html +13 -20
- data/rdoc/RubyXL/CT_AlphaModulateFixedEffect.html +13 -20
- data/rdoc/RubyXL/CT_AlphaOutsetEffect.html +13 -20
- data/rdoc/RubyXL/CT_AlphaReplaceEffect.html +13 -20
- data/rdoc/RubyXL/CT_Backdrop.html +13 -20
- data/rdoc/RubyXL/CT_Bevel.html +13 -20
- data/rdoc/RubyXL/CT_BiLevelEffect.html +13 -20
- data/rdoc/RubyXL/CT_BlendEffect.html +13 -20
- data/rdoc/RubyXL/CT_Blip.html +13 -20
- data/rdoc/RubyXL/CT_BlipFillProperties.html +13 -20
- data/rdoc/RubyXL/CT_BlurEffect.html +13 -20
- data/rdoc/RubyXL/CT_Camera.html +13 -20
- data/rdoc/RubyXL/CT_Color.html +13 -20
- data/rdoc/RubyXL/CT_ColorChangeEffect.html +13 -20
- data/rdoc/RubyXL/CT_ColorMapping.html +13 -20
- data/rdoc/RubyXL/CT_ColorScheme.html +13 -20
- data/rdoc/RubyXL/CT_ColorSchemeAndMapping.html +13 -20
- data/rdoc/RubyXL/CT_ConnectionSite.html +13 -20
- data/rdoc/RubyXL/CT_ConnectionSiteList.html +13 -20
- data/rdoc/RubyXL/CT_DashStop.html +13 -20
- data/rdoc/RubyXL/CT_DashStopList.html +13 -20
- data/rdoc/RubyXL/CT_DefaultShapeDefinition.html +13 -20
- data/rdoc/RubyXL/CT_DuotoneEffect.html +13 -20
- data/rdoc/RubyXL/CT_EffectContainer.html +13 -20
- data/rdoc/RubyXL/CT_EffectList.html +13 -20
- data/rdoc/RubyXL/CT_EffectReference.html +13 -20
- data/rdoc/RubyXL/CT_EffectStyleItem.html +13 -20
- data/rdoc/RubyXL/CT_EffectStyleList.html +13 -20
- data/rdoc/RubyXL/CT_EmbeddedWAVAudioFile.html +13 -20
- data/rdoc/RubyXL/CT_FillEffect.html +13 -20
- data/rdoc/RubyXL/CT_FillOverlayEffect.html +13 -20
- data/rdoc/RubyXL/CT_FillStyleList.html +13 -20
- data/rdoc/RubyXL/CT_FlatText.html +13 -20
- data/rdoc/RubyXL/CT_FontCollection.html +13 -20
- data/rdoc/RubyXL/CT_FontReference.html +13 -20
- data/rdoc/RubyXL/CT_GeomGuideList.html +13 -20
- data/rdoc/RubyXL/CT_GlowEffect.html +13 -20
- data/rdoc/RubyXL/CT_GradientFillProperties.html +13 -20
- data/rdoc/RubyXL/CT_GradientStop.html +13 -20
- data/rdoc/RubyXL/CT_GradientStopList.html +13 -20
- data/rdoc/RubyXL/CT_HSLEffect.html +13 -20
- data/rdoc/RubyXL/CT_HslColor.html +13 -20
- data/rdoc/RubyXL/CT_Hyperlink.html +13 -20
- data/rdoc/RubyXL/CT_InnerShadowEffect.html +13 -20
- data/rdoc/RubyXL/CT_LightRig.html +13 -20
- data/rdoc/RubyXL/CT_LineEndProperties.html +13 -20
- data/rdoc/RubyXL/CT_LineJoinMiterProperties.html +13 -20
- data/rdoc/RubyXL/CT_LineProperties.html +13 -20
- data/rdoc/RubyXL/CT_LineStyleList.html +13 -20
- data/rdoc/RubyXL/CT_LinearShadeProperties.html +13 -20
- data/rdoc/RubyXL/CT_LuminanceEffect.html +13 -20
- data/rdoc/RubyXL/CT_ObjectStyleDefaults.html +13 -20
- data/rdoc/RubyXL/CT_OuterShadowEffect.html +13 -20
- data/rdoc/RubyXL/CT_Path2D.html +13 -20
- data/rdoc/RubyXL/CT_Path2DArcTo.html +13 -20
- data/rdoc/RubyXL/CT_Path2DCubicBezierTo.html +13 -20
- data/rdoc/RubyXL/CT_Path2DList.html +13 -20
- data/rdoc/RubyXL/CT_Path2DQuadBezierTo.html +13 -20
- data/rdoc/RubyXL/CT_Path2DTo.html +13 -20
- data/rdoc/RubyXL/CT_PathShadeProperties.html +13 -20
- data/rdoc/RubyXL/CT_PatternFillProperties.html +13 -20
- data/rdoc/RubyXL/CT_Point3D.html +13 -20
- data/rdoc/RubyXL/CT_PolarAdjustHandle.html +13 -20
- data/rdoc/RubyXL/CT_PresetColor.html +13 -20
- data/rdoc/RubyXL/CT_PresetLineDashProperties.html +13 -20
- data/rdoc/RubyXL/CT_PresetShadowEffect.html +13 -20
- data/rdoc/RubyXL/CT_PresetTextShape.html +13 -20
- data/rdoc/RubyXL/CT_ReflectionEffect.html +13 -20
- data/rdoc/RubyXL/CT_RelativeOffsetEffect.html +13 -20
- data/rdoc/RubyXL/CT_RelativeRect.html +13 -20
- data/rdoc/RubyXL/CT_SRgbColor.html +13 -20
- data/rdoc/RubyXL/CT_ScRgbColor.html +13 -20
- data/rdoc/RubyXL/CT_Scene3D.html +13 -20
- data/rdoc/RubyXL/CT_SchemeColor.html +13 -20
- data/rdoc/RubyXL/CT_Shape3D.html +13 -20
- data/rdoc/RubyXL/CT_ShapeStyle.html +13 -20
- data/rdoc/RubyXL/CT_SoftEdgesEffect.html +13 -20
- data/rdoc/RubyXL/CT_SphereCoords.html +13 -20
- data/rdoc/RubyXL/CT_StretchInfoProperties.html +13 -20
- data/rdoc/RubyXL/CT_StyleMatrix.html +13 -20
- data/rdoc/RubyXL/CT_StyleMatrixReference.html +13 -20
- data/rdoc/RubyXL/CT_SupplementalFont.html +13 -20
- data/rdoc/RubyXL/CT_SystemColor.html +13 -20
- data/rdoc/RubyXL/CT_TextAutonumberBullet.html +13 -20
- data/rdoc/RubyXL/CT_TextBlipBullet.html +13 -20
- data/rdoc/RubyXL/CT_TextCharBullet.html +13 -20
- data/rdoc/RubyXL/CT_TextCharacterProperties.html +13 -20
- data/rdoc/RubyXL/CT_TextFont.html +13 -20
- data/rdoc/RubyXL/CT_TextListStyle.html +13 -20
- data/rdoc/RubyXL/CT_TextNormalAutofit.html +13 -20
- data/rdoc/RubyXL/CT_TextParagraphProperties.html +13 -20
- data/rdoc/RubyXL/CT_TextSpacing.html +13 -20
- data/rdoc/RubyXL/CT_TextTabStop.html +13 -20
- data/rdoc/RubyXL/CT_TextTabStopList.html +13 -20
- data/rdoc/RubyXL/CT_TileInfoProperties.html +13 -20
- data/rdoc/RubyXL/CT_TintEffect.html +13 -20
- data/rdoc/RubyXL/CT_Transform2D.html +13 -20
- data/rdoc/RubyXL/CT_TransformEffect.html +13 -20
- data/rdoc/RubyXL/CT_Vector3D.html +13 -20
- data/rdoc/RubyXL/CT_XYAdjustHandle.html +13 -20
- data/rdoc/RubyXL/CalculationChain.html +23 -50
- data/rdoc/RubyXL/CalculationChainCell.html +13 -20
- data/rdoc/RubyXL/CalculationProperties.html +13 -20
- data/rdoc/RubyXL/Cell.html +210 -258
- data/rdoc/RubyXL/CellConvenienceMethods.html +438 -572
- data/rdoc/RubyXL/CellExt.html +13 -20
- data/rdoc/RubyXL/CellSmartTag.html +13 -20
- data/rdoc/RubyXL/CellSmartTagProperty.html +13 -20
- data/rdoc/RubyXL/CellSmartTags.html +13 -20
- data/rdoc/RubyXL/CellStyle.html +13 -20
- data/rdoc/RubyXL/CellStyleXFs.html +25 -44
- data/rdoc/RubyXL/CellStyles.html +25 -44
- data/rdoc/RubyXL/CellValue.html +24 -43
- data/rdoc/RubyXL/CellWatch.html +13 -20
- data/rdoc/RubyXL/CellWatches.html +13 -20
- data/rdoc/RubyXL/CellXFs.html +26 -48
- data/rdoc/RubyXL/ChartColorsFile.html +12 -26
- data/rdoc/RubyXL/ChartFile.html +25 -54
- data/rdoc/RubyXL/ChartStyleFile.html +12 -26
- data/rdoc/RubyXL/ChartUserShapesFile.html +12 -26
- data/rdoc/RubyXL/Chartsheet.html +26 -73
- data/rdoc/RubyXL/ChartsheetPageSetup.html +13 -20
- data/rdoc/RubyXL/ChartsheetProperties.html +13 -20
- data/rdoc/RubyXL/ChartsheetProtection.html +13 -20
- data/rdoc/RubyXL/ChartsheetView.html +13 -20
- data/rdoc/RubyXL/ChartsheetViews.html +13 -20
- data/rdoc/RubyXL/Color.html +24 -48
- data/rdoc/RubyXL/ColorConvenienceClasses/HlsColor.html +246 -0
- data/rdoc/RubyXL/ColorConvenienceClasses/RgbColor.html +285 -0
- data/rdoc/RubyXL/ColorConvenienceClasses.html +91 -0
- data/rdoc/RubyXL/ColorConvenienceMethods.html +139 -0
- data/rdoc/RubyXL/ColorFilter.html +13 -20
- data/rdoc/RubyXL/ColorScale.html +13 -20
- data/rdoc/RubyXL/ColorSet.html +13 -20
- data/rdoc/RubyXL/Colors.html +13 -20
- data/rdoc/RubyXL/ColumnRange.html +76 -91
- data/rdoc/RubyXL/ColumnRanges.html +54 -106
- data/rdoc/RubyXL/Comment.html +13 -20
- data/rdoc/RubyXL/CommentList.html +13 -20
- data/rdoc/RubyXL/CommentsFile.html +24 -56
- data/rdoc/RubyXL/ConditionalFormatValue.html +13 -20
- data/rdoc/RubyXL/ConditionalFormatting.html +13 -20
- data/rdoc/RubyXL/ConditionalFormattingRule.html +13 -20
- data/rdoc/RubyXL/Connection.html +99 -0
- data/rdoc/RubyXL/ConnectionTable.html +99 -0
- data/rdoc/RubyXL/ConnectionTables.html +99 -0
- data/rdoc/RubyXL/ConnectionTextField.html +99 -0
- data/rdoc/RubyXL/ConnectionTextFields.html +99 -0
- data/rdoc/RubyXL/Connections.html +149 -0
- data/rdoc/RubyXL/ContentTypeDefault.html +12 -18
- data/rdoc/RubyXL/ContentTypeOverride.html +12 -18
- data/rdoc/RubyXL/ContentTypes.html +35 -72
- data/rdoc/RubyXL/ControlPropertiesFile.html +14 -23
- data/rdoc/RubyXL/CorePropertiesFile.html +89 -208
- data/rdoc/RubyXL/CustomColor.html +13 -20
- data/rdoc/RubyXL/CustomColorList.html +13 -20
- data/rdoc/RubyXL/CustomFilter.html +13 -20
- data/rdoc/RubyXL/CustomFilters.html +13 -20
- data/rdoc/RubyXL/CustomGeometry.html +13 -20
- data/rdoc/RubyXL/CustomProperties.html +13 -20
- data/rdoc/RubyXL/CustomPropertiesFile.html +12 -26
- data/rdoc/RubyXL/CustomProperty.html +13 -20
- data/rdoc/RubyXL/CustomPropertyFile.html +108 -0
- data/rdoc/RubyXL/CustomSheetView.html +13 -20
- data/rdoc/RubyXL/CustomSheetViews.html +13 -20
- data/rdoc/RubyXL/CustomWorkbookView.html +13 -20
- data/rdoc/RubyXL/CustomWorkbookViews.html +13 -20
- data/rdoc/RubyXL/CustomXMLFile.html +12 -23
- data/rdoc/RubyXL/DXF.html +13 -20
- data/rdoc/RubyXL/DXFs.html +13 -20
- data/rdoc/RubyXL/DataBar.html +13 -20
- data/rdoc/RubyXL/DataConsolidate.html +13 -20
- data/rdoc/RubyXL/DataConsolidationReference.html +13 -20
- data/rdoc/RubyXL/DataConsolidationReferences.html +13 -20
- data/rdoc/RubyXL/DataType.html +11 -40
- data/rdoc/RubyXL/DataValidation.html +13 -20
- data/rdoc/RubyXL/DataValidations.html +13 -20
- data/rdoc/RubyXL/DateGroupItem.html +13 -20
- data/rdoc/RubyXL/DefinedName.html +13 -20
- data/rdoc/RubyXL/DefinedNameExt.html +13 -20
- data/rdoc/RubyXL/DefinedNames.html +13 -20
- data/rdoc/RubyXL/DefinedNamesExt.html +13 -20
- data/rdoc/RubyXL/DocumentPropertiesFile.html +34 -76
- data/rdoc/RubyXL/DrawingFile.html +25 -54
- data/rdoc/RubyXL/DynamicFilter.html +13 -20
- data/rdoc/RubyXL/EmbeddedControl.html +13 -20
- data/rdoc/RubyXL/EmbeddedControls.html +13 -20
- data/rdoc/RubyXL/Extension.html +13 -20
- data/rdoc/RubyXL/ExtensionStorageArea.html +13 -20
- data/rdoc/RubyXL/Extents.html +13 -20
- data/rdoc/RubyXL/ExternalBook.html +13 -20
- data/rdoc/RubyXL/ExternalLinksFile.html +25 -54
- data/rdoc/RubyXL/ExternalReference.html +13 -20
- data/rdoc/RubyXL/ExternalReferences.html +13 -20
- data/rdoc/RubyXL/ExtraColorSchemeList.html +13 -20
- data/rdoc/RubyXL/FieldItem.html +13 -20
- data/rdoc/RubyXL/FileRecoveryProperties.html +13 -20
- data/rdoc/RubyXL/FileSharing.html +13 -20
- data/rdoc/RubyXL/FileVersion.html +13 -20
- data/rdoc/RubyXL/Fill.html +25 -44
- data/rdoc/RubyXL/Fills.html +25 -44
- data/rdoc/RubyXL/FilterContainer.html +13 -20
- data/rdoc/RubyXL/FloatNode.html +12 -18
- data/rdoc/RubyXL/FloatValue.html +12 -18
- data/rdoc/RubyXL/Font.html +28 -64
- data/rdoc/RubyXL/FontConvenienceMethods.html +133 -294
- data/rdoc/RubyXL/FontScheme.html +13 -20
- data/rdoc/RubyXL/Fonts.html +25 -44
- data/rdoc/RubyXL/Formula.html +13 -20
- data/rdoc/RubyXL/FunctionGroup.html +13 -20
- data/rdoc/RubyXL/FunctionGroups.html +13 -20
- data/rdoc/RubyXL/GenericStorageObject.html +41 -98
- data/rdoc/RubyXL/GradientFill.html +13 -20
- data/rdoc/RubyXL/HeaderFooterSettings.html +13 -20
- data/rdoc/RubyXL/Hyperlink.html +13 -20
- data/rdoc/RubyXL/HyperlinkRelFile.html +12 -23
- data/rdoc/RubyXL/Hyperlinks.html +13 -20
- data/rdoc/RubyXL/IconFilter.html +13 -20
- data/rdoc/RubyXL/IconSet.html +13 -20
- data/rdoc/RubyXL/IgnoredError.html +13 -20
- data/rdoc/RubyXL/IgnoredErrors.html +13 -20
- data/rdoc/RubyXL/IndexedColors.html +13 -20
- data/rdoc/RubyXL/InputCells.html +13 -20
- data/rdoc/RubyXL/IntegerNode.html +12 -18
- data/rdoc/RubyXL/IntegerValue.html +12 -18
- data/rdoc/RubyXL/LegacyCell.html +20 -71
- data/rdoc/RubyXL/LegacyWorksheet.html +77 -126
- data/rdoc/RubyXL/MRUColors.html +13 -20
- data/rdoc/RubyXL/MacrosFile.html +12 -26
- data/rdoc/RubyXL/MergedCell.html +13 -20
- data/rdoc/RubyXL/MergedCells.html +13 -20
- data/rdoc/RubyXL/NumFmt.html +13 -20
- data/rdoc/RubyXL/NumberFormat.html +25 -44
- data/rdoc/RubyXL/NumberFormats.html +25 -50
- data/rdoc/RubyXL/OLEObject.html +13 -20
- data/rdoc/RubyXL/OLEObjectFile.html +12 -26
- data/rdoc/RubyXL/OLEObjects.html +13 -20
- data/rdoc/RubyXL/OLESize.html +13 -20
- data/rdoc/RubyXL/OOXMLContainerObject.html +72 -157
- data/rdoc/RubyXL/OOXMLIgnored.html +32 -62
- data/rdoc/RubyXL/OOXMLObject.html +15 -26
- data/rdoc/RubyXL/OOXMLObjectClassMethods.html +126 -203
- data/rdoc/RubyXL/OOXMLObjectInstanceMethods.html +104 -226
- data/rdoc/RubyXL/OOXMLRelationshipsFile.html +109 -242
- data/rdoc/RubyXL/OOXMLTopLevelObject.html +67 -154
- data/rdoc/RubyXL/OdbcOleDbProperties.html +99 -0
- data/rdoc/RubyXL/Offset.html +13 -20
- data/rdoc/RubyXL/OlapProperties.html +99 -0
- data/rdoc/RubyXL/OleItem.html +99 -0
- data/rdoc/RubyXL/OleItems.html +99 -0
- data/rdoc/RubyXL/OleLink.html +99 -0
- data/rdoc/RubyXL/OutlineProperties.html +13 -20
- data/rdoc/RubyXL/PageMargins.html +13 -20
- data/rdoc/RubyXL/PageSetup.html +13 -20
- data/rdoc/RubyXL/PageSetupProperties.html +13 -20
- data/rdoc/RubyXL/Pane.html +13 -20
- data/rdoc/RubyXL/Parser.html +35 -65
- data/rdoc/RubyXL/PatternFill.html +13 -20
- data/rdoc/RubyXL/PersonMetadata.html +108 -0
- data/rdoc/RubyXL/PhoneticProperties.html +13 -20
- data/rdoc/RubyXL/PhoneticRun.html +13 -20
- data/rdoc/RubyXL/PivotArea.html +13 -20
- data/rdoc/RubyXL/PivotCache.html +13 -20
- data/rdoc/RubyXL/PivotCacheDefinitionFile.html +14 -31
- data/rdoc/RubyXL/PivotCacheRecordsFile.html +12 -26
- data/rdoc/RubyXL/PivotCaches.html +13 -20
- data/rdoc/RubyXL/PivotReference.html +13 -20
- data/rdoc/RubyXL/PivotReferences.html +13 -20
- data/rdoc/RubyXL/PivotTableFile.html +14 -31
- data/rdoc/RubyXL/PivotTableSelection.html +13 -20
- data/rdoc/RubyXL/PresetGeometry.html +13 -20
- data/rdoc/RubyXL/PrintOptions.html +13 -20
- data/rdoc/RubyXL/PrinterSettingsFile.html +12 -26
- data/rdoc/RubyXL/ProtectedRange.html +13 -20
- data/rdoc/RubyXL/ProtectedRanges.html +13 -20
- data/rdoc/RubyXL/Protection.html +13 -20
- data/rdoc/RubyXL/QueryParameter.html +99 -0
- data/rdoc/RubyXL/QueryParameters.html +99 -0
- data/rdoc/RubyXL/QueryTable.html +157 -0
- data/rdoc/RubyXL/QueryTableDeletedField.html +99 -0
- data/rdoc/RubyXL/QueryTableDeletedFields.html +99 -0
- data/rdoc/RubyXL/QueryTableField.html +99 -0
- data/rdoc/RubyXL/QueryTableFields.html +99 -0
- data/rdoc/RubyXL/QueryTableRefresh.html +99 -0
- data/rdoc/RubyXL/RID.html +12 -18
- data/rdoc/RubyXL/RawOOXML.html +33 -69
- data/rdoc/RubyXL/Reference.html +156 -286
- data/rdoc/RubyXL/Relationship.html +12 -18
- data/rdoc/RubyXL/RelationshipSupport/ClassMehods.html +20 -37
- data/rdoc/RubyXL/RelationshipSupport.html +62 -145
- data/rdoc/RubyXL/RevisionPointer.html +13 -23
- data/rdoc/RubyXL/RichText.html +27 -45
- data/rdoc/RubyXL/RichTextRun.html +24 -43
- data/rdoc/RubyXL/Row.html +88 -205
- data/rdoc/RubyXL/RowExt.html +13 -20
- data/rdoc/RubyXL/RunProperties.html +13 -20
- data/rdoc/RubyXL/Scenario.html +13 -20
- data/rdoc/RubyXL/Scenarios.html +13 -20
- data/rdoc/RubyXL/Selection.html +23 -42
- data/rdoc/RubyXL/ShapeGuide.html +13 -20
- data/rdoc/RubyXL/ShapeTextRectangle.html +13 -20
- data/rdoc/RubyXL/SharedStringsTable.html +81 -177
- data/rdoc/RubyXL/Sheet.html +13 -20
- data/rdoc/RubyXL/SheetCalculationProperties.html +13 -20
- data/rdoc/RubyXL/SheetData.html +32 -62
- data/rdoc/RubyXL/SheetDataExt.html +13 -20
- data/rdoc/RubyXL/SheetDataSet.html +13 -20
- data/rdoc/RubyXL/SheetMetadata.html +108 -0
- data/rdoc/RubyXL/SheetName.html +13 -20
- data/rdoc/RubyXL/SheetNames.html +13 -20
- data/rdoc/RubyXL/Sheets.html +13 -20
- data/rdoc/RubyXL/SlicerCacheFile.html +12 -26
- data/rdoc/RubyXL/SlicerFile.html +12 -26
- data/rdoc/RubyXL/SmartTagProperties.html +13 -20
- data/rdoc/RubyXL/SmartTagType.html +13 -20
- data/rdoc/RubyXL/SmartTagTypes.html +13 -20
- data/rdoc/RubyXL/SmartTags.html +13 -20
- data/rdoc/RubyXL/SortCondition.html +13 -20
- data/rdoc/RubyXL/SortState.html +13 -20
- data/rdoc/RubyXL/Sqref.html +33 -63
- data/rdoc/RubyXL/Stop.html +13 -20
- data/rdoc/RubyXL/StringNode.html +12 -18
- data/rdoc/RubyXL/StringNodeW3C.html +33 -63
- data/rdoc/RubyXL/StringValue.html +12 -18
- data/rdoc/RubyXL/Stylesheet.html +65 -138
- data/rdoc/RubyXL/TableFile.html +12 -26
- data/rdoc/RubyXL/TableParts.html +12 -18
- data/rdoc/RubyXL/TableStyle.html +13 -20
- data/rdoc/RubyXL/TableStyles.html +13 -20
- data/rdoc/RubyXL/Text.html +35 -76
- data/rdoc/RubyXL/TextImportSettings.html +99 -0
- data/rdoc/RubyXL/Theme.html +72 -72
- data/rdoc/RubyXL/ThemeElements.html +13 -20
- data/rdoc/RubyXL/ThumbnailFile.html +12 -26
- data/rdoc/RubyXL/Top10.html +13 -20
- data/rdoc/RubyXL/VMLDrawingFile.html +15 -33
- data/rdoc/RubyXL/Variant.html +13 -20
- data/rdoc/RubyXL/Vector.html +24 -43
- data/rdoc/RubyXL/VectorValue.html +12 -18
- data/rdoc/RubyXL/VisualProperties.html +13 -20
- data/rdoc/RubyXL/WebPublishObject.html +13 -20
- data/rdoc/RubyXL/WebPublishObjects.html +13 -20
- data/rdoc/RubyXL/WebPublishingItem.html +13 -20
- data/rdoc/RubyXL/WebPublishingItems.html +13 -20
- data/rdoc/RubyXL/WebPublishingProperties.html +13 -20
- data/rdoc/RubyXL/WebQueryProperties.html +99 -0
- data/rdoc/RubyXL/Workbook.html +581 -266
- data/rdoc/RubyXL/WorkbookConvenienceMethods.html +226 -951
- data/rdoc/RubyXL/WorkbookProperties.html +13 -20
- data/rdoc/RubyXL/WorkbookProtection.html +13 -20
- data/rdoc/RubyXL/WorkbookRoot.html +58 -135
- data/rdoc/RubyXL/WorkbookView.html +13 -20
- data/rdoc/RubyXL/WorkbookViews.html +13 -20
- data/rdoc/RubyXL/Worksheet.html +122 -137
- data/rdoc/RubyXL/WorksheetConvenienceMethods.html +717 -1373
- data/rdoc/RubyXL/WorksheetDimensions.html +13 -20
- data/rdoc/RubyXL/WorksheetFormatProperties.html +12 -18
- data/rdoc/RubyXL/WorksheetProperties.html +13 -20
- data/rdoc/RubyXL/WorksheetProtection.html +13 -20
- data/rdoc/RubyXL/WorksheetView.html +13 -20
- data/rdoc/RubyXL/WorksheetViews.html +13 -20
- data/rdoc/RubyXL/XF.html +13 -20
- data/rdoc/RubyXL.html +46 -306
- data/rdoc/created.rid +45 -38
- data/rdoc/css/rdoc.css +109 -12
- data/rdoc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/rdoc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/rdoc/index.html +403 -726
- data/rdoc/js/darkfish.js +33 -97
- data/rdoc/js/navigation.js +12 -49
- data/rdoc/js/navigation.js.gz +0 -0
- data/rdoc/js/search.js +35 -34
- data/rdoc/js/search_index.js +1 -1
- data/rdoc/js/search_index.js.gz +0 -0
- data/rdoc/js/searcher.js +6 -6
- data/rdoc/js/searcher.js.gz +0 -0
- data/rdoc/table_of_contents.html +287 -45
- data/rubyXL.gemspec +77 -43
- data/spec/lib/cell_spec.rb +119 -6
- data/spec/lib/color_spec.rb +9 -1
- data/spec/lib/parser_spec.rb +28 -28
- data/spec/lib/reference_spec.rb +41 -5
- data/spec/lib/rgb_color_spec.rb +29 -0
- data/spec/lib/stylesheet_spec.rb +10 -11
- data/spec/lib/text_spec.rb +4 -6
- data/spec/lib/workbook_spec.rb +31 -8
- data/spec/lib/worksheet_spec.rb +886 -480
- data/spec/spec_helper.rb +2 -0
- data/test/test_parse_write.rb +15 -15
- metadata +76 -10
- data/rdoc/js/jquery.js +0 -4
@@ -4,21 +4,23 @@
|
|
4
4
|
<head>
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
|
7
|
-
<title>module RubyXL::OOXMLObjectClassMethods - rubyXL 3.
|
7
|
+
<title>module RubyXL::OOXMLObjectClassMethods - rubyXL 3.4.33</title>
|
8
8
|
|
9
9
|
<script type="text/javascript">
|
10
10
|
var rdoc_rel_prefix = "../";
|
11
11
|
var index_rel_prefix = "../";
|
12
12
|
</script>
|
13
13
|
|
14
|
-
<script src="../js/
|
15
|
-
<script src="../js/
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
15
|
+
<script src="../js/search.js" defer></script>
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
16
19
|
|
17
20
|
<link href="../css/fonts.css" rel="stylesheet">
|
18
21
|
<link href="../css/rdoc.css" rel="stylesheet">
|
19
22
|
|
20
23
|
|
21
|
-
|
22
24
|
<body id="top" role="document" class="module">
|
23
25
|
<nav role="navigation">
|
24
26
|
<div id="project-navigation">
|
@@ -39,7 +41,7 @@
|
|
39
41
|
<div id="search-field-wrapper">
|
40
42
|
<input id="search-field" role="combobox" aria-label="Search"
|
41
43
|
aria-autocomplete="list" aria-controls="search-results"
|
42
|
-
type="text" name="search" placeholder="Search" spellcheck="false"
|
44
|
+
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
|
43
45
|
title="Type to search, Up and Down to navigate, Enter to load">
|
44
46
|
</div>
|
45
47
|
|
@@ -58,22 +60,18 @@
|
|
58
60
|
|
59
61
|
|
60
62
|
|
61
|
-
|
63
|
+
|
64
|
+
<!-- Method Quickref -->
|
62
65
|
<div id="method-list-section" class="nav-section">
|
63
66
|
<h3>Methods</h3>
|
64
67
|
|
65
68
|
<ul class="link-list" role="directory">
|
66
|
-
|
67
69
|
<li ><a href="#method-i-define_attribute">#define_attribute</a>
|
68
|
-
|
69
70
|
<li ><a href="#method-i-define_child_node">#define_child_node</a>
|
70
|
-
|
71
71
|
<li ><a href="#method-i-define_element_name">#define_element_name</a>
|
72
|
-
|
72
|
+
<li ><a href="#method-i-define_relationship">#define_relationship</a>
|
73
73
|
<li ><a href="#method-i-obtain_class_variable">#obtain_class_variable</a>
|
74
|
-
|
75
74
|
<li ><a href="#method-i-parse">#parse</a>
|
76
|
-
|
77
75
|
</ul>
|
78
76
|
</div>
|
79
77
|
|
@@ -89,52 +87,37 @@
|
|
89
87
|
|
90
88
|
</section>
|
91
89
|
|
92
|
-
|
93
|
-
|
94
|
-
|
95
90
|
<section id="5Buntitled-5D" class="documentation-section">
|
96
|
-
|
97
91
|
|
98
|
-
|
99
92
|
|
100
|
-
|
101
93
|
|
102
|
-
|
103
94
|
|
104
|
-
|
95
|
+
|
105
96
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
106
97
|
<header>
|
107
98
|
<h3>Public Instance Methods</h3>
|
108
99
|
</header>
|
109
100
|
|
110
|
-
|
111
101
|
<div id="method-i-define_attribute" class="method-detail ">
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
102
|
+
<div class="method-header">
|
103
|
+
<div class="method-heading">
|
104
|
+
<span class="method-name">define_attribute</span><span
|
105
|
+
class="method-args">(attr_name, attr_type, extra_params = nil)</span>
|
106
|
+
<span class="method-click-advice">click to toggle source</span>
|
107
|
+
</div>
|
119
108
|
</div>
|
120
|
-
|
121
109
|
|
122
110
|
<div class="method-description">
|
123
|
-
|
124
111
|
<p>Defines an attribute of OOXML object.</p>
|
125
112
|
|
126
113
|
<h3 id="method-i-define_attribute-label-Parameters">Parameters<span><a href="#method-i-define_attribute-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
|
127
114
|
<ul><li>
|
128
|
-
<p><code>attribute_name</code> - Name of the element attribute as seen in the
|
129
|
-
source XML. Can be either <code>"String"</code> or
|
130
|
-
<code>:Symbol</code></p>
|
115
|
+
<p><code>attribute_name</code> - Name of the element attribute as seen in the source XML. Can be either <code>"String"</code> or <code>:Symbol</code></p>
|
131
116
|
<ul><li>
|
132
|
-
<p>Special
|
133
|
-
value of the element rather than attribute.</p>
|
117
|
+
<p>Special attribute name <code>'_'</code> (underscore) denotes the value of the element rather than attribute.</p>
|
134
118
|
</li></ul>
|
135
119
|
</li><li>
|
136
|
-
<p><code>attribute_type</code> - Specifies the conversion type for the
|
137
|
-
attribute when parsing. Available options are:</p>
|
120
|
+
<p><code>attribute_type</code> - Specifies the conversion type for the attribute when parsing. Available options are:</p>
|
138
121
|
<ul><li>
|
139
122
|
<p><code>:int</code> - <code>Integer</code></p>
|
140
123
|
</li><li>
|
@@ -144,129 +127,94 @@ attribute when parsing. Available options are:</p>
|
|
144
127
|
</li><li>
|
145
128
|
<p><code>:string</code> - <code>String</code> (no conversion)</p>
|
146
129
|
</li><li>
|
147
|
-
<p><code>:sqref</code> - <a href="Sqref.html">RubyXL::Sqref</a></p>
|
130
|
+
<p><code>:sqref</code> - <a href="Sqref.html"><code>RubyXL::Sqref</code></a></p>
|
148
131
|
</li><li>
|
149
|
-
<p><code>:ref</code> - <a href="Reference.html">RubyXL::Reference</a></p>
|
132
|
+
<p><code>:ref</code> - <a href="Reference.html"><code>RubyXL::Reference</code></a></p>
|
150
133
|
</li><li>
|
151
|
-
<p><code>:bool</code> - <code>Boolean</code> (“1” and “true” convert to
|
152
|
-
<code>true</code>, others to <code>false</code>)</p>
|
134
|
+
<p><code>:bool</code> - <code>Boolean</code> (“1” and “true” convert to <code>true</code>, others to <code>false</code>)</p>
|
153
135
|
</li><li>
|
154
|
-
<p>one of <code>simple_types</code> - <code>String</code>, plus the list of
|
155
|
-
acceptable values is saved for future validation (not used yet).</p>
|
136
|
+
<p>one of <code>simple_types</code> - <code>String</code>, plus the list of acceptable values is saved for future validation (not used yet).</p>
|
156
137
|
</li></ul>
|
157
138
|
</li><li>
|
158
139
|
<p><code>extra_parameters</code> - Hash of optional parameters as follows:</p>
|
159
140
|
<ul><li>
|
160
|
-
<p><code>:accessor</code> - Name of the accessor for this attribute to be
|
161
|
-
defined on the object. If not provided, defaults to classidied
|
162
|
-
<code>attribute_name</code>.</p>
|
141
|
+
<p><code>:accessor</code> - Name of the accessor for this attribute to be defined on the object. If not provided, defaults to classidied <code>attribute_name</code>.</p>
|
163
142
|
</li><li>
|
164
|
-
<p><code>:default</code> - Value this attribute defaults to if not explicitly
|
165
|
-
provided.</p>
|
143
|
+
<p><code>:default</code> - Value this attribute defaults to if not explicitly provided.</p>
|
166
144
|
</li><li>
|
167
|
-
<p><code>:required</code> - Whether this attribute is required when writing
|
168
|
-
XML. If the value of the attrinute is not explicitly provided,
|
169
|
-
<code>:default</code> is written instead.</p>
|
145
|
+
<p><code>:required</code> - Whether this attribute is required when writing XML. If the value of the attrinute is not explicitly provided, <code>:default</code> is written instead.</p>
|
170
146
|
</li><li>
|
171
|
-
<p><code>:computed</code> - Do not store this attribute on <code>parse</code>,
|
172
|
-
but do call the object-provided read accessor on <code>write_xml</code>.</p>
|
147
|
+
<p><code>:computed</code> - Do not store this attribute on <code>parse</code>, but do call the object-provided read accessor on <code>write_xml</code>.</p>
|
173
148
|
</li></ul>
|
174
149
|
</li></ul>
|
175
150
|
|
176
151
|
<h4 id="method-i-define_attribute-label-Examples">Examples<span><a href="#method-i-define_attribute-label-Examples">¶</a> <a href="#top">↑</a></span></h4>
|
177
152
|
|
178
|
-
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(
|
153
|
+
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(<span class="ruby-value">:outline</span>, <span class="ruby-value">:bool</span>, <span class="ruby-value">:default</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>)
|
179
154
|
</pre>
|
180
155
|
|
181
|
-
<p>A <code>Boolean</code> attribute
|
182
|
-
<code>true</code> will be accessible by calling <code>obj.outline</code></p>
|
156
|
+
<p>A <code>Boolean</code> attribute ‘outline’ with default value <code>true</code> will be accessible by calling <code>obj.outline</code></p>
|
183
157
|
|
184
|
-
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(
|
158
|
+
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(<span class="ruby-value">:uniqueCount</span>, <span class="ruby-value">:int</span>)
|
185
159
|
</pre>
|
186
160
|
|
187
|
-
<p>An <code>Integer</code> attribute
|
188
|
-
<code>obj.unique_count</code></p>
|
161
|
+
<p>An <code>Integer</code> attribute ‘uniqueCount’ accessible as <code>obj.unique_count</code></p>
|
189
162
|
|
190
|
-
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(
|
163
|
+
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(<span class="ruby-value">:_</span>, <span class="ruby-value">:string</span>, <span class="ruby-value">:accessor</span> <span class="ruby-operator">=></span> <span class="ruby-value">:expression</span>)
|
191
164
|
</pre>
|
192
165
|
|
193
|
-
<p>The value of the element will be accessible as a <code>String</code> by
|
194
|
-
calling <code>obj.expression</code></p>
|
166
|
+
<p>The value of the element will be accessible as a <code>String</code> by calling <code>obj.expression</code></p>
|
195
167
|
|
196
|
-
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(
|
168
|
+
<pre class="ruby"><span class="ruby-identifier">define_attribute</span>(<span class="ruby-value">:errorStyle</span>, <span class="ruby-node">%w{ stop warning information }</span>, <span class="ruby-value">:default</span> <span class="ruby-operator">=></span> <span class="ruby-string">'stop'</span>,)
|
197
169
|
</pre>
|
198
170
|
|
199
|
-
<p>A <code>String</code> attribute named
|
200
|
-
accessible as <code>obj.error_style</code>, valid values are
|
201
|
-
<code>"stop"</code>, <code>"warning"</code>,
|
202
|
-
<code>"information"</code></p>
|
203
|
-
|
204
|
-
|
171
|
+
<p>A <code>String</code> attribute named ‘errorStyle’ will be accessible as <code>obj.error_style</code>, valid values are <code>"stop"</code>, <code>"warning"</code>, <code>"information"</code></p>
|
205
172
|
|
206
|
-
|
207
173
|
<div class="method-source-code" id="define_attribute-source">
|
208
174
|
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 48</span>
|
209
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">define_attribute</span>(<span class="ruby-identifier">attr_name</span>, <span class="ruby-identifier">attr_type</span>, <span class="ruby-identifier">extra_params</span> =
|
175
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_attribute</span>(<span class="ruby-identifier">attr_name</span>, <span class="ruby-identifier">attr_type</span>, <span class="ruby-identifier">extra_params</span> = <span class="ruby-keyword">nil</span>)
|
210
176
|
<span class="ruby-identifier">attrs</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_attributes</span>)
|
211
|
-
<span class="ruby-identifier">attr_hash</span> =
|
177
|
+
<span class="ruby-identifier">attr_hash</span> = { <span class="ruby-value">:attr_type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">attr_type</span> }
|
178
|
+
<span class="ruby-identifier">attr_hash</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">extra_params</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">extra_params</span>
|
212
179
|
<span class="ruby-identifier">attr_hash</span>[<span class="ruby-value">:accessor</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">accessorize</span>(<span class="ruby-identifier">attr_name</span>)
|
213
180
|
<span class="ruby-identifier">attrs</span>[<span class="ruby-identifier">attr_name</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-identifier">attr_hash</span>
|
214
181
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:attr_accessor</span>, <span class="ruby-identifier">attr_hash</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">attr_hash</span>[<span class="ruby-value">:computed</span>]
|
215
182
|
<span class="ruby-keyword">end</span></pre>
|
216
183
|
</div>
|
217
|
-
|
218
184
|
</div>
|
219
185
|
|
220
|
-
|
221
186
|
|
222
|
-
|
223
187
|
</div>
|
224
188
|
|
225
|
-
|
226
189
|
<div id="method-i-define_child_node" class="method-detail ">
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
190
|
+
<div class="method-header">
|
191
|
+
<div class="method-heading">
|
192
|
+
<span class="method-name">define_child_node</span><span
|
193
|
+
class="method-args">(klass, extra_params = {})</span>
|
194
|
+
<span class="method-click-advice">click to toggle source</span>
|
195
|
+
</div>
|
234
196
|
</div>
|
235
|
-
|
236
197
|
|
237
198
|
<div class="method-description">
|
238
|
-
|
239
199
|
<p>Defines a child node of OOXML object.</p>
|
240
200
|
|
241
201
|
<h3 id="method-i-define_child_node-label-Parameters">Parameters<span><a href="#method-i-define_child_node-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
|
242
202
|
<ul><li>
|
243
|
-
<p><code>klass</code> - Class (descendant of <a
|
244
|
-
href="OOXMLObject.html">RubyXL::OOXMLObject</a>) of the child nodes. Child
|
245
|
-
node objects will be produced by calling <code>parse</code> method of that
|
246
|
-
class.</p>
|
203
|
+
<p><code>klass</code> - Class (descendant of <a href="OOXMLObject.html"><code>RubyXL::OOXMLObject</code></a>) of the child nodes. Child node objects will be produced by calling <code>parse</code> method of that class.</p>
|
247
204
|
</li><li>
|
248
205
|
<p><code>extra_parameters</code> - Hash of optional parameters as follows:</p>
|
249
206
|
<ul><li>
|
250
|
-
<p><code>:accessor</code> - Name of the accessor for this attribute to be
|
251
|
-
defined on the object. If not provided, defaults to classidied
|
252
|
-
<code>attribute_name</code>.</p>
|
207
|
+
<p><code>:accessor</code> - Name of the accessor for this attribute to be defined on the object. If not provided, defaults to classidied <code>attribute_name</code>.</p>
|
253
208
|
</li><li>
|
254
|
-
<p><code>:node_name</code> - Node name for the child node, in case it does not
|
255
|
-
match the one defined by the <code>klass</code>.</p>
|
209
|
+
<p><code>:node_name</code> - Node name for the child node, in case it does not match the one defined by the <code>klass</code>.</p>
|
256
210
|
</li><li>
|
257
|
-
<p><code>:collection</code> - Whether the child node should be treated as a
|
258
|
-
single node or a collection of nodes:</p>
|
211
|
+
<p><code>:collection</code> - Whether the child node should be treated as a single node or a collection of nodes:</p>
|
259
212
|
<ul><li>
|
260
|
-
<p><code>false</code> (default) - child node is directly accessible through
|
261
|
-
the respective accessor;</p>
|
213
|
+
<p><code>false</code> (default) - child node is directly accessible through the respective accessor;</p>
|
262
214
|
</li><li>
|
263
|
-
<p><code>true</code> - a collection of child nodes is accessed as
|
264
|
-
<code>Array</code> through the respective accessor;</p>
|
215
|
+
<p><code>true</code> - a collection of child nodes is accessed as <code>Array</code> through the respective accessor;</p>
|
265
216
|
</li><li>
|
266
|
-
<p><code>:with_count</code> - same as <code>true</code>, but in addition, the
|
267
|
-
attribute <code>count</code> is defined on the current object, that will be
|
268
|
-
automatically set to the number of elements in the collection at the start
|
269
|
-
of <code>write_xml</code> call.</p>
|
217
|
+
<p><code>:with_count</code> - same as <code>true</code>, but in addition, the attribute <code>count</code> is defined on the current object, that will be automatically set to the number of elements in the collection at the start of <code>write_xml</code> call.</p>
|
270
218
|
</li></ul>
|
271
219
|
</li></ul>
|
272
220
|
</li></ul>
|
@@ -276,43 +224,35 @@ of <code>write_xml</code> call.</p>
|
|
276
224
|
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Alignment</span>)
|
277
225
|
</pre>
|
278
226
|
|
279
|
-
<p>Define a singular child node parsed by the RubyXL::BorderEdge.parse() and
|
280
|
-
accessed by the default <code>obj.alignment</code> accessor</p>
|
227
|
+
<p>Define a singular child node parsed by the RubyXL::BorderEdge.parse() and accessed by the default <code>obj.alignment</code> accessor</p>
|
281
228
|
|
282
|
-
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Hyperlink</span>,
|
229
|
+
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Hyperlink</span>, <span class="ruby-value">:collection</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>, <span class="ruby-value">:accessor</span> <span class="ruby-operator">=></span> <span class="ruby-value">:hyperlinks</span>)
|
283
230
|
</pre>
|
284
231
|
|
285
|
-
<p>Define an array of nodes accessed by <code>obj.hyperlinks</code> accessor,
|
286
|
-
each of which will be parsed by the RubyXL::Hyperlink.parse()</p>
|
232
|
+
<p>Define an array of nodes accessed by <code>obj.hyperlinks</code> accessor, each of which will be parsed by the RubyXL::Hyperlink.parse()</p>
|
287
233
|
|
288
|
-
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">BorderEdge</span>,
|
289
|
-
<span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">BorderEdge</span>,
|
234
|
+
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">BorderEdge</span>, <span class="ruby-value">:node_name</span> <span class="ruby-operator">=></span> <span class="ruby-value">:left</span>)
|
235
|
+
<span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">BorderEdge</span>, <span class="ruby-value">:node_name</span> <span class="ruby-operator">=></span> <span class="ruby-value">:right</span>)
|
290
236
|
</pre>
|
291
237
|
|
292
|
-
<p>Use class <a href="BorderEdge.html">RubyXL::BorderEdge</a> when parsing
|
293
|
-
both the elements <code><left ...></code> and <code><right
|
294
|
-
...></code> elements.</p>
|
238
|
+
<p>Use class <a href="BorderEdge.html"><code>RubyXL::BorderEdge</code></a> when parsing both the elements <code><left ...></code> and <code><right ...></code> elements.</p>
|
295
239
|
|
296
|
-
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Font</span>,
|
240
|
+
<pre class="ruby"><span class="ruby-identifier">define_child_node</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Font</span>, <span class="ruby-value">:collection</span> <span class="ruby-operator">=></span> <span class="ruby-value">:with_count</span>, <span class="ruby-value">:accessor</span> <span class="ruby-operator">=></span> <span class="ruby-value">:fonts</span>)
|
297
241
|
</pre>
|
298
242
|
|
299
|
-
<p>Upon writing of the object this was defined on, its <code>count</code>
|
300
|
-
attribute will be set to the count of nodes in <code>fonts</code> array</p>
|
301
|
-
|
302
|
-
|
243
|
+
<p>Upon writing of the object this was defined on, its <code>count</code> attribute will be set to the count of nodes in <code>fonts</code> array</p>
|
303
244
|
|
304
|
-
|
305
245
|
<div class="method-source-code" id="define_child_node-source">
|
306
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
307
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">define_child_node</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">extra_params</span> = {})
|
246
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 82</span>
|
247
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_child_node</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">extra_params</span> = {})
|
308
248
|
<span class="ruby-identifier">child_nodes</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>)
|
309
249
|
<span class="ruby-identifier">child_node_name</span> = (<span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:node_name</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">class_variable_get</span>(<span class="ruby-value">:@@ooxml_tag_name</span>)).<span class="ruby-identifier">to_s</span>
|
310
250
|
<span class="ruby-identifier">accessor</span> = (<span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:accessor</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">accessorize</span>(<span class="ruby-identifier">child_node_name</span>)).<span class="ruby-identifier">to_sym</span>
|
311
251
|
|
312
252
|
<span class="ruby-identifier">child_nodes</span>[<span class="ruby-identifier">child_node_name</span>] = {
|
313
|
-
<span class="ruby-value">:class</span>
|
314
|
-
<span class="ruby-value">:is_array</span>
|
315
|
-
<span class="ruby-value">:accessor</span>
|
253
|
+
<span class="ruby-value">:class</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">klass</span>,
|
254
|
+
<span class="ruby-value">:is_array</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:collection</span>],
|
255
|
+
<span class="ruby-value">:accessor</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">accessor</span>
|
316
256
|
}
|
317
257
|
|
318
258
|
<span class="ruby-identifier">define_count_attribute</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:collection</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:with_count</span>
|
@@ -320,33 +260,22 @@ attribute will be set to the count of nodes in <code>fonts</code> array</p>
|
|
320
260
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:attr_accessor</span>, <span class="ruby-identifier">accessor</span>)
|
321
261
|
<span class="ruby-keyword">end</span></pre>
|
322
262
|
</div>
|
323
|
-
|
324
263
|
</div>
|
325
264
|
|
326
|
-
|
327
265
|
|
328
|
-
|
329
266
|
</div>
|
330
267
|
|
331
|
-
|
332
268
|
<div id="method-i-define_element_name" class="method-detail ">
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
269
|
+
<div class="method-header">
|
270
|
+
<div class="method-heading">
|
271
|
+
<span class="method-name">define_element_name</span><span
|
272
|
+
class="method-args">(element_name)</span>
|
273
|
+
<span class="method-click-advice">click to toggle source</span>
|
274
|
+
</div>
|
340
275
|
</div>
|
341
|
-
|
342
276
|
|
343
277
|
<div class="method-description">
|
344
|
-
|
345
|
-
<p>Defines the name of the element that represents the current OOXML object.
|
346
|
-
Should only be used once per object. In case of different objects
|
347
|
-
represented by the same class in different parts of OOXML tree,
|
348
|
-
<code>:node_name</code> extra parameter can be used to override the default
|
349
|
-
element name.</p>
|
278
|
+
<p>Defines the name of the element that represents the current OOXML object. Should only be used once per object. In case of different objects represented by the same class in different parts of OOXML tree, <code>:node_name</code> extra parameter can be used to override the default element name.</p>
|
350
279
|
|
351
280
|
<h3 id="method-i-define_element_name-label-Parameters">Parameters<span><a href="#method-i-define_element_name-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
|
352
281
|
<ul><li>
|
@@ -357,89 +286,83 @@ element name.</p>
|
|
357
286
|
|
358
287
|
<pre class="ruby"><span class="ruby-identifier">define_element_name</span> <span class="ruby-string">'externalReference'</span>
|
359
288
|
</pre>
|
360
|
-
|
361
|
-
|
362
289
|
|
363
|
-
|
364
290
|
<div class="method-source-code" id="define_element_name-source">
|
365
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
366
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">define_element_name</span>(<span class="ruby-identifier">element_name</span>)
|
291
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 110</span>
|
292
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_element_name</span>(<span class="ruby-identifier">element_name</span>)
|
367
293
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-value">:@@ooxml_tag_name</span>, <span class="ruby-identifier">element_name</span>)
|
368
294
|
<span class="ruby-keyword">end</span></pre>
|
369
295
|
</div>
|
370
|
-
|
371
296
|
</div>
|
372
297
|
|
373
|
-
|
374
298
|
|
375
|
-
|
376
299
|
</div>
|
377
300
|
|
378
|
-
|
301
|
+
<div id="method-i-define_relationship" class="method-detail ">
|
302
|
+
<div class="method-header">
|
303
|
+
<div class="method-heading">
|
304
|
+
<span class="method-name">define_relationship</span><span
|
305
|
+
class="method-args">(extra_params = {})</span>
|
306
|
+
<span class="method-click-advice">click to toggle source</span>
|
307
|
+
</div>
|
308
|
+
</div>
|
309
|
+
|
310
|
+
<div class="method-description">
|
311
|
+
<p>Defines a ‘r:id` attribute</p>
|
312
|
+
|
313
|
+
<div class="method-source-code" id="define_relationship-source">
|
314
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 58</span>
|
315
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_relationship</span>(<span class="ruby-identifier">extra_params</span> = {})
|
316
|
+
<span class="ruby-identifier">define_attribute</span>(<span class="ruby-value">:'r:id'</span>, <span class="ruby-value">:string</span>, <span class="ruby-identifier">extra_params</span>)
|
317
|
+
<span class="ruby-keyword">end</span></pre>
|
318
|
+
</div>
|
319
|
+
</div>
|
320
|
+
|
321
|
+
|
322
|
+
</div>
|
323
|
+
|
379
324
|
<div id="method-i-obtain_class_variable" class="method-detail ">
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
325
|
+
<div class="method-header">
|
326
|
+
<div class="method-heading">
|
327
|
+
<span class="method-name">obtain_class_variable</span><span
|
328
|
+
class="method-args">(var_name, default = nil)</span>
|
329
|
+
<span class="method-click-advice">click to toggle source</span>
|
330
|
+
</div>
|
387
331
|
</div>
|
388
|
-
|
389
332
|
|
390
333
|
<div class="method-description">
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
not specified)</p>
|
395
|
-
|
396
|
-
<p>Throughout this class, we are setting class variables through explicit
|
397
|
-
method calls rather than by directly addressing the name of the variable
|
398
|
-
because of context issues: addressing variable by name creates it in the
|
399
|
-
context of defining class, while calling the setter/getter method addresses
|
400
|
-
it in the context of descendant class, which is what we need.</p>
|
401
|
-
|
402
|
-
|
334
|
+
<p>Get the value of a [sub]class variable if it exists, or create the respective variable with the passed-in <code>default</code> (or +{}+, if not specified)</p>
|
335
|
+
|
336
|
+
<p>Throughout this class, we are setting class variables through explicit method calls rather than by directly addressing the name of the variable because of context issues: addressing variable by name creates it in the context of defining class, while calling the setter/getter method addresses it in the context of descendant class, which is what we need.</p>
|
403
337
|
|
404
|
-
|
405
338
|
<div class="method-source-code" id="obtain_class_variable-source">
|
406
339
|
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 15</span>
|
407
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-identifier">var_name</span>, <span class="ruby-identifier">default</span> =
|
340
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">obtain_class_variable</span>(<span class="ruby-identifier">var_name</span>, <span class="ruby-identifier">default</span> = <span class="ruby-keyword">nil</span>)
|
408
341
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_get</span>(<span class="ruby-identifier">var_name</span>)
|
409
342
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">NameError</span>
|
410
|
-
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-identifier">var_name</span>, <span class="ruby-identifier">default</span>)
|
343
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-identifier">var_name</span>, <span class="ruby-identifier">default</span> <span class="ruby-operator">||</span> {})
|
411
344
|
<span class="ruby-keyword">end</span></pre>
|
412
345
|
</div>
|
413
|
-
|
414
346
|
</div>
|
415
347
|
|
416
|
-
|
417
348
|
|
418
|
-
|
419
349
|
</div>
|
420
350
|
|
421
|
-
|
422
351
|
<div id="method-i-parse" class="method-detail ">
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
|
429
|
-
|
352
|
+
<div class="method-header">
|
353
|
+
<div class="method-heading">
|
354
|
+
<span class="method-name">parse</span><span
|
355
|
+
class="method-args">(node, known_namespaces = nil)</span>
|
356
|
+
<span class="method-click-advice">click to toggle source</span>
|
357
|
+
</div>
|
430
358
|
</div>
|
431
|
-
|
432
359
|
|
433
360
|
<div class="method-description">
|
434
361
|
|
435
|
-
|
436
|
-
|
437
|
-
|
438
362
|
|
439
|
-
|
440
363
|
<div class="method-source-code" id="parse-source">
|
441
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
442
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">node</span>, <span class="ruby-identifier">known_namespaces</span> = <span class="ruby-keyword">nil</span>)
|
364
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 114</span>
|
365
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse</span>(<span class="ruby-identifier">node</span>, <span class="ruby-identifier">known_namespaces</span> = <span class="ruby-keyword">nil</span>)
|
443
366
|
<span class="ruby-keyword">case</span> <span class="ruby-identifier">node</span>
|
444
367
|
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>, <span class="ruby-constant">IO</span>, <span class="ruby-constant">Zip</span><span class="ruby-operator">::</span><span class="ruby-constant">InputStream</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">node</span> = <span class="ruby-constant">Nokogiri</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">node</span>)
|
445
368
|
<span class="ruby-keyword">end</span>
|
@@ -451,7 +374,9 @@ it in the context of descendant class, which is what we need.</p>
|
|
451
374
|
<span class="ruby-keyword">end</span>
|
452
375
|
|
453
376
|
<span class="ruby-identifier">obj</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>
|
454
|
-
<span class="ruby-identifier">
|
377
|
+
<span class="ruby-identifier">hsh</span> = {}
|
378
|
+
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">namespace_definitions</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">ns</span><span class="ruby-operator">|</span> <span class="ruby-identifier">hsh</span>[<span class="ruby-identifier">ns</span>.<span class="ruby-identifier">href</span>] = <span class="ruby-identifier">ns</span>.<span class="ruby-identifier">prefix</span> }
|
379
|
+
<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">local_namespaces</span> = <span class="ruby-identifier">hsh</span>
|
455
380
|
|
456
381
|
<span class="ruby-identifier">known_attributes</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_attributes</span>)
|
457
382
|
|
@@ -476,9 +401,11 @@ it in the context of descendant class, which is what we need.</p>
|
|
476
401
|
<span class="ruby-identifier">known_namespaces</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_namespaces</span>)
|
477
402
|
|
478
403
|
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">element_children</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">child_node</span><span class="ruby-operator">|</span>
|
479
|
-
|
480
404
|
<span class="ruby-identifier">ns</span> = <span class="ruby-identifier">child_node</span>.<span class="ruby-identifier">namespace</span>
|
481
|
-
|
405
|
+
|
406
|
+
<span class="ruby-identifier">prefix</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">known_namespaces</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">ns</span>&.<span class="ruby-identifier">href</span>) <span class="ruby-keyword">then</span> <span class="ruby-identifier">known_namespaces</span>[<span class="ruby-identifier">ns</span>&.<span class="ruby-identifier">href</span>]
|
407
|
+
<span class="ruby-keyword">else</span> <span class="ruby-identifier">ns</span>&.<span class="ruby-identifier">prefix</span>
|
408
|
+
<span class="ruby-keyword">end</span>
|
482
409
|
|
483
410
|
<span class="ruby-identifier">child_node_name</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">prefix</span>
|
484
411
|
<span class="ruby-keyword">when</span> <span class="ruby-string">''</span>, <span class="ruby-keyword">nil</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">child_node</span>.<span class="ruby-identifier">name</span>
|
@@ -509,24 +436,20 @@ it in the context of descendant class, which is what we need.</p>
|
|
509
436
|
<span class="ruby-identifier">obj</span>
|
510
437
|
<span class="ruby-keyword">end</span></pre>
|
511
438
|
</div>
|
512
|
-
|
513
439
|
</div>
|
514
440
|
|
515
|
-
|
516
441
|
|
517
|
-
|
518
442
|
</div>
|
519
443
|
|
520
|
-
|
521
444
|
</section>
|
522
|
-
|
445
|
+
|
523
446
|
</section>
|
524
447
|
</main>
|
525
448
|
|
526
449
|
|
527
450
|
<footer id="validator-badges" role="contentinfo">
|
528
|
-
<p><a href="
|
529
|
-
<p>Generated by <a href="https://
|
451
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
452
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.3.1.
|
530
453
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
531
454
|
</footer>
|
532
455
|
|